-
Notifications
You must be signed in to change notification settings - Fork 1
Add releasing docs and ensure prereleases are supported #38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Releasing the Dependency-Track documentation | ||
|
|
||
| The site is versioned with [mike] and deployed by [`docs.yml`]: | ||
|
|
||
| - Push to `main` deploys the `next` alias. | ||
| - Push of a `<major>.<minor>.<patch>` tag deploys a versioned snapshot, | ||
| updates the `<major>.<minor>` and `latest` aliases, and sets `latest` | ||
| as default. | ||
|
nscuro marked this conversation as resolved.
|
||
| - Push of a prerelease tag (e.g. `5.7.0-rc.1`) deploys a snapshot | ||
| under the full version. It does not touch `latest` or the default. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. `make lint` and `make build` pass on the target branch. | ||
| 2. Generated reference content matches the API server release. Re-run | ||
| `update-config-docs`, `update-proto-docs`, and `update-openapi-docs` | ||
| if needed and merge their PRs first. | ||
| 3. Any release blog post is merged before the tag is pushed (see | ||
| [Blog posts](#blog-posts)). | ||
|
|
||
| ## Stable version | ||
|
|
||
| To release `5.7.0` or `5.7.1`: | ||
|
|
||
| ```sh | ||
| git tag 5.7.0 | ||
| git push origin 5.7.0 | ||
| ``` | ||
|
|
||
| For 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. | ||
|
|
||
| ## Prerelease version | ||
|
|
||
| To release `5.7.0-rc.1` or `5.7.0-beta.1`: | ||
|
|
||
| ```sh | ||
| git tag 5.7.0-rc.1 | ||
| git push origin 5.7.0-rc.1 | ||
| ``` | ||
|
|
||
| Verify `dependencytrack.github.io/docs/5.7.0-rc.1/` is reachable and | ||
| that `latest` still points at the previous stable release. | ||
|
|
||
| ## Blog posts | ||
|
|
||
| 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 and | ||
| `categories: [Release]`. | ||
| - Remove `draft: true` before merging. Drafts render in `make serve` | ||
| but are excluded from `make build` and mike. | ||
| - Edits to old posts do not backport. A fix on `main` updates `next` | ||
| and future tags but leaves `5.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. | ||
|
|
||
| [mike]: https://github.com/jimporter/mike | ||
| [`docs.yml`]: .github/workflows/docs.yml | ||
| [blog plugin]: https://squidfunk.github.io/mkdocs-material/plugins/blog/ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.