From a3a18fd45bda2e81009e1d1bb7539dffb6146b4e Mon Sep 17 00:00:00 2001 From: Elliot Goodrich Date: Mon, 1 Jul 2024 21:42:42 +0100 Subject: [PATCH] Build and deploy documentation Build and deploy TypeDoc documentation whenever there is a commit to `main`. --- .github/workflows/documentation.yaml | 35 ++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/documentation.yaml diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml new file mode 100644 index 0000000..e08393b --- /dev/null +++ b/.github/workflows/documentation.yaml @@ -0,0 +1,35 @@ +name: Documentation + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: latest + cache: 'npm' + - run: cd configure && npm ci + - run: npm run docs + - uses: actions/upload-pages-artifact@v3 + with: + path: "./docs" + deploy: + runs-on: ubuntu-latest + needs: build + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4