Skip to content

Release requirements (#315) #36

Release requirements (#315)

Release requirements (#315) #36

Workflow file for this run

name: Update Docs
on:
push:
branches:
- develop
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions: {}
jobs:
check_files:
runs-on: ubuntu-latest
outputs:
docs_changed: ${{ steps.check_changed_files.outputs.docs_changed }}
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
fetch-depth: 0
- id: check_changed_files
run: |
# Diff HEAD
diff=$(git diff --name-only ${{ github.event.before }} ${{ github.event.after }})
# Check for changes in docs/
docs_changed=false
for FILE in $diff; do
if [[ "$FILE" == docs/* ]]; then
docs_changed=true
fi
done
# Set output
echo "docs_changed=$docs_changed" >> $GITHUB_OUTPUT
# Run job only if changes occurred in docs/
deploy:
permissions:
contents: write
issues: write
pull-requests: write
runs-on: ubuntu-latest
needs: [ check_files ]
if: needs.check_files.outputs.docs_changed == 'true'
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
with:
key: mkdocs-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-
- run: pip install -r .github/doc-requirements.txt
- run: mkdocs gh-deploy --force