Release docs: finalize now updates the website - #286
Open
royteeuwen wants to merge 2 commits into
Open
Conversation
The CLI's finalize command updates the releases list and the downloads page as its last step, so document that rather than telling the release manager to do it afterwards, and describe how downloads entries are matched (artifact id, same major version only). The news page stays manual, via update-news. Also correct the manual downloads instructions: the page needs updating for every release, not only for new modules, and it lists only the most recent major version of a module even when older ones are still distributed.
Nothing in the release process depends on the project's version order, and the CLI's finalize command performs the rest of the Update JIRA section.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Follows apache/sling-org-apache-sling-committer-cli#40, which makes the Committer CLI's
finalizecommand update the website as its last step.Finalize section
Documents the website step instead of telling the release manager to do it afterwards, and describes how downloads entries are matched: on the artifact id rather than the module's display name (the two often differ — Tracer is listed as Log Tracer), and only for entries on the same major version, so a maintenance release of an older line never downgrades the page. Also notes that the news page stays manual, via
update-news, and how to resumefinalizeby release name after promotion.Promoting the Release section
Two corrections to the manual instructions:
releases.mdanddownloads.tpltogether; the renovate app is a lagging backstop rather than the primary path (PR Update dependency org.apache.sling:org.apache.sling.resourceresolver to v2.0.2 #221 was open from September 2025 to April 2026).Also notes which of these steps the CLI now performs, and that the site's own build and deploy delay already covers most of the CDN wait.
Update JIRA section
Drops the "keep the versions sorted" step — nothing in the release process depends on the project's version order — and points at
finalize, which performs the rest of that section.