[docs] Exclude unrelated files #42
Workflow file for this run
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: Publish docs via GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'mkdocs.yml' | |
| - '.github/workflows/docs.yml' | |
| - 'docs/**' | |
| - 'benchmarks/**/*.md' | |
| - 'post-processing/**/*.md' | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - 'mkdocs.yml' | |
| - '.github/workflows/docs.yml' | |
| - 'docs/**' | |
| - 'benchmarks/**/*.md' | |
| - 'post-processing/**/*.md' | |
| concurrency: | |
| # Same group concurrency as the `docs_cleanup.yml` workflow, because they both | |
| # git-push to the same branch, so we want to avoid clashes. NOTE: this is | |
| # different from the concurrency group below, which is to cancel successive | |
| # jobs from within the branch/PR. | |
| group: docs-pushing | |
| jobs: | |
| build: | |
| timeout-minutes: 10 | |
| name: Deploy docs | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| # Skip intermediate builds: always. | |
| # Cancel intermediate builds: always. | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| # See | |
| # <https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token>. | |
| # We need `contents: write` to push the docs to the `gh-pages` branch, and | |
| # `statuses: write` to create the custom status. | |
| contents: write | |
| statuses: write | |
| steps: | |
| - name: Checkout main | |
| uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10.6' | |
| cache: 'pip' | |
| - name: Install Python dependencies | |
| run: pip install mkdocs-material github3.py | |
| - name: Checkout gh-pages | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: gh-pages | |
| path: gh-pages | |
| - name: Build docs | |
| run: | | |
| if [[ ${{ github.event_name }} == 'pull_request' ]]; then | |
| export MKDOCS_SITE_DIR="site/preview/PR${{ github.event.number }}" | |
| export MKDOCS_SITE_URL="https://ukri-excalibur.github.io/excalibur-tests/preview/PR${{ github.event.number }}" | |
| fi | |
| mkdocs build | |
| - name: Deploy docs | |
| # Run only if push is to `main`, or if it's a PR not from a fork. | |
| if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'pull_request' && ! github.event.pull_request.head.repo.fork) }} | |
| run: | | |
| cd gh-pages | |
| cp -fr ../site/* . | |
| git config user.name ${{github.actor}} | |
| git config user.email "${{github.actor_id}}+${{github.actor}}@users.noreply.github.com" | |
| git add . | |
| if [[ ${{ github.event_name }} == 'pull_request' ]]; then | |
| COMMIT_MESSAGE="Update docs preview from ${{ github.sha }} for PR #${{ github.event.number }}" | |
| else | |
| COMMIT_MESSAGE="Update docs from ${{ github.sha }}" | |
| fi | |
| git commit -m "${COMMIT_MESSAGE}" | |
| git push origin gh-pages | |
| - name: Create custom status for pull requests | |
| # Similar condition as previous step, but only for PRs | |
| if: ${{ github.event_name == 'pull_request' && ! github.event.pull_request.head.repo.fork }} | |
| shell: python {0} | |
| run: | | |
| from github3 import login | |
| token = "${{ github.token }}" | |
| gh = login(token=token) | |
| owner, repo_name = "${{ github.repository }}".split('/') | |
| repo = gh.repository(owner, repo_name) | |
| sha = "${{ github.event.pull_request.head.sha }}" | |
| state = "success" | |
| target_url = "https://ukri-excalibur.github.io/excalibur-tests/preview/PR${{ github.event.number }}/" | |
| description = "Documentation deployed" | |
| context = "${{ github.workflow }} / Preview" | |
| repo.create_status(sha, state, target_url, description, context) |