Merge pull request #392 from DiamondLightSource/fix-pipfile #190
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: Docs CI | |
on: | |
push: | |
branches: | |
# Add more branches here to publish docs from other branches | |
- master | |
- main | |
tags: | |
- "*" | |
pull_request: | |
jobs: | |
build: | |
name: "Docs CI" | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout Source | |
uses: actions/checkout@v2 | |
with: | |
# require history to get back to last tag for version number of branches | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: "3.7" | |
- name: Install Packages | |
run: sudo apt-get install graphviz | |
- name: Install Python Dependencies | |
run: | | |
pip install pipenv | |
pipenv install --dev --deploy --python $(which python) && pipenv graph | |
- name: Build Docs | |
run: pipenv run docs | |
- name: Move to versioned directory | |
# e.g. master or 0.1.2 | |
run: mv build/html ".github/pages/${GITHUB_REF##*/}" | |
- name: Avoid git conflicts when tag and branch pushed at same time | |
if: startsWith(github.ref, 'refs/tags') | |
run: sleep 60 | |
- name: Publish Docs to gh-pages | |
if: github.event_name == 'push' | |
# We pin to the SHA, not the tag, for security reasons. | |
# https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions | |
uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: .github/pages | |
keep_files: true |