The site is versioned with mike and deployed by docs.yml:
- Push to
maindeploys thenextalias. - Push of a
<major>.<minor>.<patch>tag deploys a versioned snapshot, updates the<major>.<minor>andlatestaliases, and setslatestas default. - Push of a prerelease tag (e.g.
5.7.0-rc.1) deploys a snapshot under the full version. It does not touchlatestor the default.
make lintandmake buildpass on the target branch.- Generated reference content matches the API server release. Re-run
update-config-docs,update-proto-docs, andupdate-openapi-docsif needed and merge their PRs first. - Any release blog post is merged before the tag is pushed (see Blog posts).
To release 5.7.0 or 5.7.1:
git tag 5.7.0
git push origin 5.7.0For bugfix releases, tag on the maintenance branch (e.g. 5.6.x).
Verify dependencytrack.github.io/docs/latest/ and /5.7/ both serve
the new build, and the version selector lists the new entry.
To release 5.7.0-rc.1 or 5.7.0-beta.1:
git tag 5.7.0-rc.1
git push origin 5.7.0-rc.1Verify dependencytrack.github.io/docs/5.7.0-rc.1/ is reachable and
that latest still points at the previous stable release.
The site uses the MkDocs Material blog plugin. Mike freezes the blog per version, so:
- Author release posts on the target branch before tagging. A post merged after the tag will not appear in that version's snapshot.
- Set an absolute
date:matching the release day andcategories: [Release]. - Remove
draft: truebefore merging. Drafts render inmake servebut are excluded frommake buildand mike. - Edits to old posts do not backport. A fix on
mainupdatesnextand future tags but leaves5.7/untouched. To correct an archived version, redeploy it from a fixup commit on the maintenance branch. - The RSS feed is per version. Treat
latest/blog/as the canonical blog URL for external links.