Skip to content

v0.0.1

v0.0.1 #23

Workflow file for this run

name: documentation
on:
push:
branches:
- main
release:
types: [published]
permissions:
contents: write
pages: write
jobs:
build_docs:
runs-on: ubuntu-latest
if: github.repository == 'roahmlab/rtd-code-python'
steps:
- uses: actions/checkout@v4
# - uses: actions/setup-python@v3
# - name: Install dependencies
# run: |
# pip install sphinx sphinx_rtd_theme myst_parser
# ssh-agent sh -c 'echo "${{ secrets.ZONOPY_KEY }}" | ssh-add - && git clone [email protected]:roahmlab/zonopy.git'
# cd zonopy && pip install -e . --no-dependencies && cd ..
# ssh-agent sh -c 'echo "${{ secrets.ZONOPYROB_KEY }}" | ssh-add - && git clone [email protected]:roahmlab/zonopy-robots.git'
# cd zonopy-robots && pip install -e . --no-dependencies && cd ..
# pip install -e .
# - name: Sphinx build
# run: |
# sphinx-build docs/source docs/build
# - name: Deploy to GitHub Pages
# uses: peaceiris/actions-gh-pages@v3
# if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
# with:
# publish_branch: gh-pages
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: _build/
# force_orphan: true
- name: 'Run the buildscript'
# Workaround to keep tty working
# https://github.com/gfx/example-github-actions-with-tty
shell: 'script -q -e -c "bash {0}"'
run: ./docs/build-docs.sh ${{ fromJSON('{"tag":"html","branch":"html-dev"}')[github.ref_type] }}
# Cache the build so we can deploy it
- name: 'cache built docs'
id: cache-build
uses: actions/cache/save@v4
with:
path: ${{ github.workspace }}/docs/build/html
key: ${{ github.sha }}-docs
# Cache version generation script if we are on a tag
- name: 'cache version generation script'
id: cache-version-script
uses: actions/cache/save@v4
if: github.ref_type == 'tag'
with:
path: ${{ github.workspace }}/docs/generate_versions.sh
key: ${{ github.sha }}-docs
deploy_main_docs:
permissions:
contents: write
pages: write
runs-on: ubuntu-latest
name: 'Publish latest docs to github pages'
needs: build_docs
if: github.ref_type == 'branch' && github.ref == 'refs/heads/main' && github.repository == 'roahmlab/rtd-code-python'
steps:
- name: 'Restore built docs cache'
uses: actions/cache/restore@v4
id: restore-build
with:
path: ${{ github.workspace }}/docs/build/html
key: ${{ github.sha }}-docs
- name: 'Deploy to gh-pages'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
publish_branch: gh-pages
destination_dir: dev
deploy_version_docs:
permissions:
contents: write
pages: write
runs-on: ubuntu-latest
name: 'Publish versioned documentation to github pages'
needs: build_docs
if: github.ref_type == 'tag' && github.repository == 'roahmlab/rtd-code-python'
steps:
- name: 'Checkout the repo'
uses: actions/checkout@v4
with:
ref: gh-pages
path: ./public
- name: 'Get cached version script'
uses: actions/cache/restore@v4
with:
path: ${{ github.workspace }}/docs/generate_versions.sh
key: ${{ github.sha }}-docs
- name: 'Get cached version build'
uses: actions/cache/restore@v4
with:
path: ${{ github.workspace }}/docs/build/html
key: ${{ github.sha }}-docs
- name: 'Move file & directories & run version update script'
shell: 'script -q -e -c "bash {0}"'
run: >
mv ./docs/generate_versions.sh ./public/generate_versions.sh
&& mv ./docs/build/html ./public/${{ github.ref_name }}
&& rm -rf ./docs/
&& ./public/generate_versions.sh
&& rm -f ./public/generate_versions.sh
- name: 'Update latest symlink and kill git'
shell: 'script -q -e -c "bash {0}"'
run: cd ./public/ && ln -sfn ./${{ github.ref_name }} ./latest && ls -la
# - name: 'Deploy to gh-pages'
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./public
# publish_branch: gh-pages
- name: 'Manually deploy to gh-pages'
run: |
git config --global user.email "${{github.actor}}@users.noreply.github.com"
git config --global user.name "${{github.actor}}"
cd ./public
git add .
git commit -m "deploy: ${{ github.sha }}" && git push origin gh-pages