docs: fix some comments #484
This file contains 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: Build docs preview | |
| # This job builds and deploys documenation to github pages. | |
| # It runs on every push to master with a change in the docs folder. | |
| on: | |
| pull_request: | |
| jobs: | |
| Build-preview: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v4 | |
| - name: Compute diff 📜 | |
| uses: technote-space/get-diff-action@v6.1.2 | |
| id: git_diff | |
| with: | |
| PATTERNS: | | |
| *.md | |
| docs/**/*.* | |
| - name: Setup Node.js 🔧 | |
| if: env.GIT_DIFF | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "16.x" | |
| cache: 'yarn' | |
| cache-dependency-path: | | |
| docs/yarn.lock | |
| - name: Build 🔧 | |
| if: env.GIT_DIFF | |
| run: make build-docs && mv ~/output ./output | |
| - name: Deploy preview to Netlify 🚀 | |
| if: env.GIT_DIFF | |
| id: deploy-preview | |
| uses: nwtgck/actions-netlify@v3.0 | |
| with: | |
| publish-dir: ./output | |
| deploy-message: "Deploy from GitHub Actions" | |
| enable-commit-comment: false | |
| enable-pull-request-comment: false | |
| overwrites-pull-request-comment: false | |
| env: | |
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | |
| NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} | |
| - name: Comment preview URL 🗨️ | |
| if: env.GIT_DIFF | |
| uses: thollander/actions-comment-pull-request@v2 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| message: '👀 Docs preview available here: ${{ steps.deploy-preview.outputs.deploy-url }}' | |
| comment_tag: '👀 Docs preview available here: ' |