Hey everyone,

Just finished the 9.8.1 release and I realized there was some confusion
about how Changelog entries are supposed to be entered for bugfix releases.

When committing to "main" and "branch_9x" (or "branch_10x"), include the
change as an entry of the next minor release. So 9.8.1 entries would be
placed under the "9.9.0" changelog header. This way, if the 9.8.1 release
never happens, they will be included in the 9.9.0 changelog notes.
(Similarly, they should have the 9.9 version in JIRA, in addition to 9.8.1,
for the same reason)

When backporting to branch_9_8, then it will be placed under the "9.8.1"
changelog header.

When the release manager is cleaning things up after the release, it's
their responsibility to add the 9.8.1 changelog section to "main" and
"branch_9x", and remove those entries from the "9.9.0" section.

It's somewhat of an annoyance for the release manager, but there's a
process for it, and this is the only way that we can be sure that nothing
gets missed from the changelog if a bugfix release never happens.

Hope this helps!

- Houston

Reply via email to