Merge pull request #26 from maffettone/mnt-docs-gha #56
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: Documentation | |
| on: [push, pull_request, workflow_dispatch] | |
| jobs: | |
| docs: | |
| # pull requests are a duplicate of a branch push if they are from within the | |
| # same repo. Skip these | |
| if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [3.8] | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| # These packages are installed in the base environment but may be older | |
| # versions. Explicitly upgrade them because they often create | |
| # installation problems if out of date. | |
| python -m pip install --upgrade pip setuptools numpy | |
| pip install . | |
| pip install -r requirements-dev.txt | |
| pip list | |
| - name: Build Docs | |
| run: | | |
| make -C docs/ html | |
| - name: Upload built docs as artifacts | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: docs | |
| path: build | |
| - name: Set env.REPOSITORY_NAME # just the repo, as opposed to org/repo | |
| run: echo "REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV | |
| - name: Deploy documentation to blueskyproject.io. | |
| if: github.repository_owner == 'bluesky' && github.ref_name == 'master' | |
| # We pin to the SHA, not the tag, for security reasons. | |
| # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions | |
| uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501 # v3.7.3 | |
| with: | |
| deploy_key: ${{ secrets.ACTIONS_DOCUMENTATION_DEPLOY_KEY }} | |
| publish_branch: master | |
| publish_dir: build/html | |
| external_repository: bluesky/bluesky.github.io | |
| destination_dir: ${{ env.REPOSITORY_NAME }} # just the repo name, without the "bluesky/" | |
| keep_files: true # Keep old files. | |
| force_orphan: false # Keep git history. |