RUST-CI-003 link promoted Rust starter issues #315
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: Documentation Site | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - '.github/workflows/docs-site.yml' | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - 'requirements-docs.txt' | |
| - 'scripts/docs-item-taxonomy-check.py' | |
| - 'scripts/docs-structure-check.py' | |
| - 'scripts/github-roadmap-check.py' | |
| pull_request: | |
| paths: | |
| - '.github/workflows/docs-site.yml' | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - 'requirements-docs.txt' | |
| - 'scripts/docs-item-taxonomy-check.py' | |
| - 'scripts/docs-structure-check.py' | |
| - 'scripts/github-roadmap-check.py' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| name: Build documentation site | |
| runs-on: ubuntu-latest | |
| env: | |
| NO_MKDOCS_2_WARNING: '1' | |
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: 'true' | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.x' | |
| cache: pip | |
| cache-dependency-path: requirements-docs.txt | |
| - name: Install documentation dependencies | |
| run: python -m pip install -r requirements-docs.txt | |
| - name: Run documentation checks | |
| run: | | |
| python scripts/docs-item-taxonomy-check.py | |
| python scripts/docs-structure-check.py | |
| python scripts/github-roadmap-check.py | |
| - name: Build MkDocs site | |
| run: python -m mkdocs build --strict | |
| - name: Configure GitHub Pages | |
| if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }} | |
| uses: actions/configure-pages@v6 | |
| - name: Upload GitHub Pages artifact | |
| if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }} | |
| uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: .local/mkdocs-site | |
| deploy: | |
| name: Deploy documentation site | |
| if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| env: | |
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: 'true' | |
| 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@v5 |