When using mike for versioning, what should the github actions workflow look like?

[adambirds]

When using mike for versioning, what should the github actions workflow look like?

I couldn't find this documented anywhere.

[squidfunk]

I have no example, since we're not using it for the official docs, but you could just search on GitHub for something like mike deploy, to learn how other users do that. It shouldn't be too hard, since you basically just have to extract the current tag/release name and use that for publishing instead of mkdocs gh-deploy.

Feel free to come back here and share your final GitHub Actions workflow.

[adambirds]

Thanks, shared below and marked as answered.

[squidfunk]

Thanks for sharing!

[adambirds]

I ended up figuring it out and using the below CI files:

Develop Docs - Updates on every push to which ever branch contains the latest development, in my case that's main.

name: Build/Publish Develop Docs 
on:
  push:
    branches:
      - main
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v4
        with:
          python-version: 3.10.6
      - name: Install Dependencies
        run: |
          pip install mkdocs-material
          pip install pillow cairosvg mike
      - name: Setup Docs Deploy
        run: |
          git config --global user.name "Docs Deploy"
          git config --global user.email "[email protected]"
      - name: Build Docs Website
        run: mike deploy --push develop

Release Docs - Creates the permanent docs for each release:

name: Build/Publish Latest Release Docs

on:
  release:
    types: [published]

permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v4
        with:
          python-version: 3.10.6
      - name: Install Dependencies
        run: |
          pip install mkdocs-material
          pip install pillow cairosvg mike
      - name: Setup Docs Deploy
        run: |
          git config --global user.name "Docs Deploy"
          git config --global user.email "[email protected]"
      - name: Build Docs Website
        run: mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest

[Andre601]

Nice, that's what I was looking for right now.

Tho, I wonder if it can be made in actions to have versions like v2.3.3 be summarized to v2.3.x to not have multiple docs for changes that are pretty much the same (Tho, from what I understand is mike smart enough to only make new versions for changed files?

Also, as a small side-note, you may want to add a tags-ignore: ['**'] for the default action, otherwise a release will trigger a push too, causing two actions to run simultaniously and causing a race-condition or something like that.

[Andre601]

Something I do wonder about the solution provided is... What about defining the default alias/version? Is that a necessary step or is mike recognizing "dev" or "latest" as default branches?