hardware.docs.yaml

name: hardware.docs

on:
  workflow_dispatch:
  push:
    branches: [ master ]
    paths:
    - 'hardware/**'
    - '.config/**'
    - '.github/**'

jobs:
  Schematics:
    runs-on: ubuntu-latest
    continue-on-error: true
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: 'recursive'

    # RUN
    - name: kicad-exports schematics
      uses: nerdyscout/kicad-exports@v2.3
      with:
        config: ./.config/schematics.kibot.yaml
        dir: hardware/docs
        board: hardware/MCB19.kicad_pcb
        schema: hardware/MCB19.sch

    # CHECK
    - name: "check output: schematics"
      run: |
        test -f hardware/docs/MCB19-Schematic*.svg && \
        test -f hardware/docs/MCB19-Schematic*.pdf && \
        test -f hardware/docs/MCB19-Board*.pdf

    # UPLOAD
    - name: Upload Schematics
      uses: actions/upload-artifact@v3
      with:
        name: schematics
        path: hardware/docs

  Bom:
    runs-on: ubuntu-latest
    continue-on-error: true
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: 'recursive'
    # RUN
    - name: kicad-exports bom
      uses: nerdyscout/kicad-exports@v2.3
      with:
        config: ./.config/bom.kibot.yaml
        dir: hardware/docs/bom
        board: hardware/MCB19.kicad_pcb
        schema: hardware/MCB19.sch

    # CHECK
    - name: "check output: bom"
      run: |
        test -f hardware/docs/bom/MCB19-interactive-bom.html && \
        test -f hardware/docs/bom/MCB19-bom.html && \
        test -f hardware/docs/bom/MCB19-bom.csv && \
        test -f hardware/docs/bom/MCB19-bom.xlsx

    # UPLOAD
    - name: Upload Bom
      uses: actions/upload-artifact@v3
      with:
        name: bom
        path: hardware/docs/bom

  Plot:
    runs-on: ubuntu-latest
    continue-on-error: true
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: 'recursive'

    # RUN
    - name: kicad-exports plot
      uses: nerdyscout/kicad-exports@v2.3
      with:
        config: ./.config/plot.kibot.yaml
        dir: hardware/docs/imgs
        schema: hardware/MCB19.sch
        board: hardware/MCB19.kicad_pcb

    # CHECK
    - name: "check output: plot"
      run: |
        test -f hardware/docs/imgs/MCB19-top.svg && \
        test -f hardware/docs/imgs/MCB19-bottom.svg

    # UPLOAD
    - name: Upload Plot
      uses: actions/upload-artifact@v3
      with:
        name: plot
        path: hardware/docs/imgs

  Model:
    runs-on: ubuntu-latest
    continue-on-error: true
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: 'recursive'

    # RUN
    - name: kicad-exports model
      uses: nerdyscout/kicad-exports@v2.3
      with:
        config: ./.config/model.kibot.yaml
        dir: hardware/docs/cad
        schema: hardware/MCB19.sch
        board: hardware/MCB19.kicad_pcb

    # CHECK
    - name: "check output: model"
      run: |
        test -f hardware/docs/cad/MCB19.step

    # UPLOAD
    - name: Upload Model
      uses: actions/upload-artifact@v3
      with:
        name: model
        path: hardware/docs/cad

  Gerbers:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: 'recursive'

    # RUN
    - name: kicad-exports gerbers
      uses: nerdyscout/kicad-exports@v2.3
      with:
        config: ./.config/gerbers.kibot.yaml
        dir: hardware/docs/gerbers
        board: hardware/MCB19.kicad_pcb
        schema: hardware/MCB19.sch

    # CHECK
    - name: "check output: fabrications"
      run: |
        test -f hardware/docs/gerbers/*B_CrtYd.gbr && \
        test -f hardware/docs/gerbers/*F_CrtYd.gbr && \
        test -f hardware/docs/gerbers/*B_Cu.gbr && \
        test -f hardware/docs/gerbers/*F_Cu.gbr && \
        test -f hardware/docs/gerbers/*B_Mask.gbr && \
        test -f hardware/docs/gerbers/*F_Mask.gbr && \
        test -f hardware/docs/gerbers/*B_Paste.gbr && \
        test -f hardware/docs/gerbers/*F_Paste.gbr && \
        test -f hardware/docs/gerbers/*B_SilkS.gbr && \
        test -f hardware/docs/gerbers/*F_SilkS.gbr && \
        test -f hardware/docs/gerbers/*B_CrtYd.gbr && \
        test -f hardware/docs/gerbers/*F_CrtYd.gbr && \
        test -f hardware/docs/gerbers/*NPTH*.gbr && \
        test -f hardware/docs/gerbers/*NPTH*.drl && \
        test -f hardware/docs/gerbers/*-PTH*.gbr && \
        test -f hardware/docs/gerbers/*-PTH*.drl && \
        test -f hardware/docs/gerbers/*_pos.csv

    # UPLOAD
    - name: Upload Gerbers
      uses: actions/upload-artifact@v3
      with:
        name: gerbers
        path: hardware/docs/gerbers

  Boardview:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
      with:
        submodules: 'recursive'

    # RUN
    - name: kicad-exports BoardView
      uses: nerdyscout/kicad-exports@v2.3
      with:
        config: ./.config/boardview.kibot.yaml
        dir: hardware/docs/boardview
        board: hardware/MCB19.kicad_pcb
        schema: hardware/MCB19.sch

    # CHECK
    - name: "check output: boardview"
      run: |
        test -f hardware/docs/boardview/*.brd

    # UPLOAD
    - name: Upload BoardView
      uses: actions/upload-artifact@v3
      with:
        name: boardview
        path: hardware/docs/boardview

  Publish:
    runs-on: ubuntu-latest
    needs: [Schematics, Bom, Plot, Model, BoardView]
    steps:
    - uses: actions/checkout@v3
      with:
        ref: 'gh-pages'

    # CLEAN
    - run: rm -rf ./hardware

    # DOWNLOAD ARTIFACTS
    - name: Download Schematics
      uses: actions/download-artifact@v3
      if: ${{ always() }}
      with:
        name: schematics
        path: hardware/schematics
    - name: Download Bom
      uses: actions/download-artifact@v3
      if: ${{ always() }}
      with:
        name: bom
        path: hardware/bom
    - name: Download Plot
      uses: actions/download-artifact@v3
      if: ${{ always() }}
      with:
        name: plot
        path: hardware/layout
    - name: Download Model
      uses: actions/download-artifact@v3
      if: ${{ always() }}
      with:
        name: model
        path: hardware/cad
    - name: Download Gerbers
      uses: actions/download-artifact@v3
      if: ${{ always() }}
      with:
        name: gerbers
        path: hardware/gerbers
    - name: Download BoardView
      uses: actions/download-artifact@v3
      if: ${{ always() }}
      with:
        name: boardview
        path: hardware/boardview

    # CREATE CONTENT
    - name: Create Content
      run: ./create_content.sh

    # PUBLISH
    - name: Publish Hardware Docs
      uses: peaceiris/actions-gh-pages@v3.9.1
      if: ${{ always() }}
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_branch: gh-pages
        publish_dir: ./
        enable_jekyll: true
        force_orphan: false
        keep_files: false
        commit_message: ${{ github.event.head_commit.message  }}
        #user_name: 'github-actions[bot]'
        #user_email: 'actions[bot]@users.noreply.github.com'
        destination_dir: ./