From c354fe19428317a52d4a5246126ebdddf498e6e5 Mon Sep 17 00:00:00 2001 From: Jake Wagoner Date: Tue, 12 Mar 2024 15:49:51 -0600 Subject: [PATCH] Add docs deployment action --- .github/workflows/deploy_docs.yml | 38 +++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/deploy_docs.yml diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml new file mode 100644 index 00000000..3ca6c7e1 --- /dev/null +++ b/.github/workflows/deploy_docs.yml @@ -0,0 +1,38 @@ +name: Deploy Documentation + +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-22.04 + permissions: + contents: write + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + steps: + - uses: actions/checkout@v3 + + - uses: actions/setup-node@v3 + with: + node-version: lts/* + cache: "yarn" + + - name: Install dependencies + run: yarn install --immutable + + - name: Run yarn build + run: yarn build + + - name: Run yarn doc + # build typedocs with yarn doc command + run: yarn doc + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs \ No newline at end of file