Skip to content
Documentation Build

Update release workflow to reflect use of 'version' branches #280

Sign in to view logs

Update release workflow to reflect use of 'version' branches

Update release workflow to reflect use of 'version' branches #280

Workflow file for this run

.github/workflows/docs.yml at c48126c
name: "Documentation Build"
concurrency:
group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
cancel-in-progress: true
on:
- pull_request
- release
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[doc]
- name: Build documentation
run: |
# SPHINXOPTS="-W --keep-going -n" is used to turn warnings into errors
# but keep going, so we don't fail on the first one.
make -C docs html SPHINXOPTS="-W --keep-going -n"
- uses: actions/upload-artifact@v2
with:
name: DocumentationHTML
path: docs/build/html/
# Publish built docs to gh-pages branch
- name: Commit documentation changes
# push docs only when a GitHub Release is made
if: github.event_name == 'release' && github.event.action == 'published'
run: |
git clone https://github.com/IMAP-Science-Operations-Center/imap_processing.git --branch gh-pages --single-branch gh-pages
cp -r docs/build/html/* gh-pages/
cd gh-pages
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore that.
- name: Publish docs
# push docs only when a GitHub Release is made
if: github.event_name == 'release' && github.event.action == 'published'
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}