Version Policy¶
Tag To Docs Version Mapping¶
- Git tag format:
vX.Y.Z - Published docs stream:
X.Y
Examples:
v1.0.0-> docs version1.0v1.3.4-> docs version1.3
Alias Rules¶
latest: newest released docs streamstable: mirrorslatestnext: prerelease documentation from mainline
Publish Commands¶
./scripts/publish-docs-version.sh v1.0.0 --push
This wrapper runs:
mike deploy --branch docs-site --update-aliases 1.0 latest stable
mike set-default --branch docs-site latest
Guardrails¶
- Do not publish from
docs-sitebranch - Do not publish if tag format is invalid
- Always validate docs with
mkdocs build --strictbefore deploy