From f712d1b03fdd944be2989e42b89447fbba577144 Mon Sep 17 00:00:00 2001 From: Valentin Roland Date: Sat, 4 Nov 2023 00:34:18 +0100 Subject: [PATCH] Generate export artifacts and deploy to GH pages in CI (#1) --- .github/workflows/main.yml | 53 ++++++++++++++++++++++++++++++++++++++ Makefile | 3 --- README.md | 9 ++++++- 3 files changed, 61 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..bb19383 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,53 @@ +name: CI +on: + push: + branches: [ main ] +jobs: + build-artifacts: + runs-on: ubuntu-latest + + steps: + - name: install kicad + run: | + sudo add-apt-repository --yes ppa:kicad/kicad-7.0-releases + sudo apt update + sudo apt install kicad + - run: kicad-cli version + - name: install kikit + run: | + pip install kikit + pip install mistune==2.0.5 + pip install PcbDraw + sudo apt install make cmark xsltproc librsvg2-bin + - name: Checkout repo + uses: actions/checkout@v4 + - name: build present page + run: make web + - run: tree build/ + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v2 + with: + path: build/web/ + + # Deploy job + deploy: + # Add a dependency to the build job + needs: build-artifacts + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + # Specify runner + deployment step + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 + diff --git a/Makefile b/Makefile index 4a53fb7..bd3303e 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,5 @@ .PHONY: web -# inspired by https://github.com/RoboticsBrno/RB0002-BatteryPack/blob/master/Makefile - - BOARDS = epdiy-v7 extension-cable web: build/web/index.html diff --git a/README.md b/README.md index c698b13..696b74f 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,13 @@ git clone git@github.com:vroland/epdiy.git --recursive ## Available Hardware -TODO: Link. +The full list of available hardware is available at [vroland.github.io/epdiy-hardware/](https://vroland.github.io/epdiy-hardware/). +For each board, we provide: + +- Gerber files +- Bill of Materials (BoM) +- Pick & Place Positioning file +- PDF Schematic +- 3D model of the board for use in CAD Creative Commons Attribution-ShareAlike 4.0 International License Creative Commons License