Skip to content

Update lifecycle information upon release #453

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.

Sign up for GitHub

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

Closed
ppkarwasz wants to merge 1 commit into from
Closed

Update lifecycle information upon release #453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,11 @@ For instance, `site-project.version` needs to be updated for `logging-parent`.
----
./mvnw -N -P changelog-release
----
.. Edit the release notes (i.e., `src/changelog/7.8.0/.release-notes.adoc.ftl`)
.. Open the generated release-notes template (`src/changelog/<version>/.release-notes.adoc.ftl`) and summarize the key user-visible changes for this release (e.g., new features, behavioral changes, significant bug fixes).
.. Inspect all files under `src/changelog/<version>/` and ensure the entries accurately reflect what users need to know.
In particular, ensure that all user-visible changes are documented and that no internal-only changes are included (e.g., test-only changes, test dependency updates, documentation updates, etc.).
.. Review the changelog (i.e., `src/changelog/7.8.0/`) to ensure all changes pertinent to the user and only those are included (e.g., exclude documentation updates, test dependencies bumps, etc.).
.. In case this is **not** a patch release, ensure that the end-of-maintenance dates of the previous releases is updated.

. Commit & push your changes:
+
Expand Down