Skip to content

docs: updated current gomod version in docs to 1.26 #297

docs: updated current gomod version in docs to 1.26

docs: updated current gomod version in docs to 1.26 #297

Workflow file for this run

# https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
name: Publish documentation
on:
release:
types: [released]
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
workflow_dispatch:
permissions:
contents: write
jobs:
deploy-release:
if: github.event_name == 'release'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
ref: refs/tags/${{ github.event.release.tag_name }}
# mike needs the full git history to manage versioned deployments
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@v6
with:
python-version: "3.10"
- run: echo "cache_id=$(date --utc '+%V')" >> "$GITHUB_ENV"
- uses: actions/cache@v5
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: mkdocs-material-
- run: pip install mkdocs-material mike
- name: Check if this is the latest release
id: latest
env:
GH_TOKEN: ${{ github.token }}
run: |
LATEST_TAG=$(gh release view --json tagName -q .tagName)
if [ "$LATEST_TAG" = "${{ github.event.release.tag_name }}" ]; then
echo "is_latest=true" >> "$GITHUB_OUTPUT"
else
echo "is_latest=false" >> "$GITHUB_OUTPUT"
fi
- name: Deploy release docs
if: steps.latest.outputs.is_latest == 'true'
run: |
mike deploy --push --update-aliases \
${{ github.event.release.tag_name }} latest
mike set-default --push latest
deploy-dev:
if: github.event_name != 'release'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
# mike needs the full git history to manage versioned deployments
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@v6
with:
python-version: "3.10"
- run: echo "cache_id=$(date --utc '+%V')" >> "$GITHUB_ENV"
- uses: actions/cache@v5
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: mkdocs-material-
- run: pip install mkdocs-material mike
- name: Deploy dev docs
run: mike deploy --push dev