Skip to content

feat: Hook system for partition cleanup lifecycle #8

feat: Hook system for partition cleanup lifecycle

feat: Hook system for partition cleanup lifecycle #8

Workflow file for this run

---
name: documentation
on: # yamllint disable-line rule:truthy
push:
tags:
- "v*"
pull_request:
paths:
- "docs/**"
- "mkdocs.yml"
- "requirements-docs.txt"
- "cmd/docgen/**"
permissions:
contents: write
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-go@v5
with:
go-version: stable
- uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install documentation dependencies
run: pip install -r requirements-docs.txt
- name: Generate CLI reference
run: make docs-generate
- name: Set version from tag
if: startsWith(github.ref, 'refs/tags/v')
run: echo "PPM_VERSION=${GITHUB_REF#refs/tags/}" >> "$GITHUB_ENV"
- name: Build documentation
run: mkdocs build --strict
- name: Configure git for mike
if: startsWith(github.ref, 'refs/tags/v')
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
- name: Deploy versioned docs
if: startsWith(github.ref, 'refs/tags/v')
run: |
mike deploy --push --update-aliases $PPM_VERSION latest
mike set-default --push latest