Skip to content

Merge pull request #255 from Sage-Bionetworks/develop #61

Merge pull request #255 from Sage-Bionetworks/develop

Merge pull request #255 from Sage-Bionetworks/develop #61

name: "Pull Request Docs Check"
on:
push:
branches:
- main
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Standard drop-in approach that should work for most people.
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
# Great extra actions to compose with:
# Create an artifact of the html output.
- uses: actions/[email protected]
with:
name: DocumentationHTML
path: docs/_build/html/
# Publish built docs to gh-pages branch.
# ===============================
- name: Commit documentation changes
run: |
git clone https://github.com/Sage-Bionetworks/challengeutils.git --branch gh-pages --single-branch gh-pages
cp -r docs/_build/html/* gh-pages/
cd gh-pages
git config --local user.email "[email protected]"
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: Push changes
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
force: true
# ===============================