ci(deps): bump actions/checkout from 4 to 6 #73
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 Documentation to GitHub Pages (DISABLED) | |
| # DISABLED: Documentation now built locally only | |
| # To re-enable, remove this comment and uncomment the 'on' section below | |
| # on: | |
| # push: | |
| # branches: | |
| # - main | |
| # paths: | |
| # - 'docs/**' | |
| # - 'mkdocs.yml' | |
| # - '.github/workflows/deploy-docs.yml' | |
| # - 'README.md' | |
| # - 'src/**/README.md' | |
| # - '*.md' | |
| # workflow_dispatch: | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy: | |
| name: Deploy documentation to gh-pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install -r docs/requirements.txt | |
| - name: Sync README files | |
| run: | | |
| python scripts/sync-readme-docs.py | |
| - name: Build MkDocs site | |
| run: | | |
| mkdocs build --clean | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./site | |
| publish_branch: gh-pages | |
| force_orphan: true | |
| user_name: 'github-actions[bot]' | |
| user_email: 'github-actions[bot]@users.noreply.github.com' | |
| commit_message: 'Deploy documentation from ${{ github.sha }}' |