docs: add versioning with mike (#88) #29
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| tags: | |
| - 'v*' | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - '.github/workflows/docs.yml' | |
| permissions: | |
| contents: write | |
| concurrency: | |
| group: docs-deploy | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Setup Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.x' | |
| - name: Install dependencies | |
| run: pip install mkdocs-material mike | |
| - name: Fetch gh-pages | |
| run: git fetch origin gh-pages --depth=1 || true | |
| - name: Configure git | |
| run: | | |
| git config user.name github-actions[bot] | |
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| - name: Deploy docs with mike | |
| shell: bash | |
| run: | | |
| set -e | |
| deploy_version () { | |
| local VERSION="$1" | |
| local UPDATE_LATEST="${2:-false}" | |
| VERSION="${VERSION#v}" | |
| MINOR=$(echo "$VERSION" | sed -E 's/^([0-9]+\.[0-9]+).*/\1/') | |
| echo "Deploying docs version: $MINOR" | |
| if [ "$UPDATE_LATEST" = "true" ]; then | |
| mike deploy --push --update-aliases "$MINOR" latest | |
| return | |
| fi | |
| mike deploy --push "$MINOR" | |
| } | |
| # | |
| # Develop branch | |
| # | |
| if [ "${{ github.ref_type }}" = "branch" ] && [ "${{ github.ref_name }}" = "develop" ]; then | |
| echo "Deploying dev docs" | |
| mike deploy --push dev | |
| exit 0 | |
| fi | |
| # | |
| # Release tags | |
| # | |
| if [ "${{ github.ref_type }}" = "tag" ]; then | |
| VERSION="${{ github.ref_name }}" | |
| if [[ ! "$VERSION" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then | |
| echo "Skipping non-stable release tag: $VERSION" | |
| exit 0 | |
| fi | |
| deploy_version "$VERSION" true | |
| echo "Setting default docs version: latest" | |
| mike set-default --push latest | |
| exit 0 | |
| fi | |
| echo "Unsupported ref" | |
| exit 1 |