chore: setup docs #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy docs to GitHub Pages | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| # Review gh actions docs if you want to further define triggers, paths, etc | ||
| # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on | ||
| jobs: | ||
| build: | ||
| name: Build Docusaurus | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| cache: npm | ||
| - name: Install dependencies | ||
| working-directory: ./docs | ||
| run: npm ci | ||
| - name: Build website | ||
| working-directory: ./docs | ||
| run: npm run build | ||
| - name: Upload Build Artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| working-directory: ./docs | ||
|
Check failure on line 32 in .github/workflows/deploy-docs.yml
|
||
| with: | ||
| path: build | ||
| deploy: | ||
| name: Deploy to GitHub Pages | ||
| needs: build | ||
| # 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 }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
| working-directory: ./docs | ||
