name: Deploy Docs to GitHub Pages on: push: branches: [main] paths: - 'docusaurus/**' pull_request: branches: ['**'] paths: - 'docusaurus/**' permissions: contents: write # required to deploy to GitHub Pages concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: ${{ !contains(github.ref, 'main')}} jobs: deploy: name: Deploy to GitHub Pages runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 - name: Setup Deps uses: ./.github/actions/setup-deps with: working-directory: ./docusaurus - name: Build website working-directory: ./docusaurus run: yarn build # Popular action to deploy to GitHub Pages: # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 if: github.ref == 'refs/heads/main' with: github_token: ${{ secrets.GITHUB_TOKEN }} # Build output to publish to the `gh-pages` branch: publish_dir: ./docusaurus/build # The following lines assign commit authorship to the official # GH-Actions bot for deploys to `gh-pages` branch: # https://github.com/actions/checkout/issues/13#issuecomment-724415212 # The GH actions bot is used by default if you didn't specify the two fields. # You can swap them out with your own user credentials. user_name: github-actions[bot] user_email: 41898282+github-actions[bot]@users.noreply.github.com