Merge tag 'v0.17.0' into develop #75
This file contains hidden or 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: Publish Docs | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| tags: | |
| - "v*" | |
| workflow_dispatch: | |
| inputs: | |
| version: | |
| description: "Version label to deploy (e.g. 0.15.0)" | |
| required: true | |
| alias: | |
| description: "Optional alias (e.g. latest, rc)" | |
| required: false | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| with: | |
| fetch-depth: 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@v7 | |
| with: | |
| python-version: 3.x | |
| - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
| - uses: actions/cache@v4 | |
| with: | |
| key: mkdocs-material-${{ env.cache_id }} | |
| path: .cache | |
| restore-keys: | | |
| mkdocs-material- | |
| - run: pip install mkdocs-material mike | |
| - name: Deploy versioned docs | |
| env: | |
| VERSION_INPUT: ${{ github.event.inputs.version }} | |
| ALIAS_INPUT: ${{ github.event.inputs.alias }} | |
| run: | | |
| if [ -n "${VERSION_INPUT}" ]; then | |
| VERSION="${VERSION_INPUT}" | |
| if [ -n "${ALIAS_INPUT}" ]; then | |
| ALIAS="${ALIAS_INPUT}" | |
| else | |
| ALIAS="latest" | |
| fi | |
| elif [ "${GITHUB_REF_TYPE}" = "tag" ]; then | |
| VERSION="${GITHUB_REF_NAME#v}" | |
| ALIAS="latest" | |
| elif [ "${GITHUB_REF_NAME}" = "develop" ]; then | |
| VERSION="develop" | |
| ALIAS="" | |
| else | |
| echo "No version provided and ref is not a tag or develop; aborting." | |
| exit 1 | |
| fi | |
| if [ -n "${ALIAS}" ] && [ "${ALIAS}" != "${VERSION}" ]; then | |
| echo "Deploying docs version '${VERSION}' with alias '${ALIAS}'" | |
| mike deploy --push --update-aliases "${VERSION}" "${ALIAS}" | |
| else | |
| echo "Deploying docs version '${VERSION}' without alias" | |
| mike deploy --push "${VERSION}" | |
| fi | |
| if [ "${ALIAS}" = "latest" ]; then | |
| mike set-default --push latest | |
| fi | |
| - name: Publish .well-known at docs site root | |
| run: | | |
| git fetch origin gh-pages | |
| git worktree add /tmp/gh-pages gh-pages | |
| mkdir -p /tmp/gh-pages/.well-known | |
| cp .well-known/funding-manifest-urls /tmp/gh-pages/.well-known/funding-manifest-urls | |
| cd /tmp/gh-pages | |
| git add .well-known/funding-manifest-urls | |
| if ! git diff --cached --quiet; then | |
| git commit -m "Update .well-known/funding-manifest-urls" | |
| git push origin gh-pages | |
| else | |
| echo "No changes to .well-known file" | |
| fi |