Simplify the Release Notes tracking process #107
Replies: 3 comments
-
An idea that was discussed during sig-release meetings was to introduce a bot that would remind users to mark the PR as relevant for release notes if appropriate, and possibly to add a short description to aid the process. One of the big points during the conversation was to make this as frictionless as possible. Being an open-source project, O3DE relies on contributions from all sort of sources, which may not have the bandwidth to jump through multiple hoops to get their changes to be even considered for review; as such, the consensus was that this automation should trigger after the change has been submitted. Here is a first draft of what the process could look like:
|
Beta Was this translation helpful? Give feedback.
-
I support going down this path. Another benefit here is that at any point in time, the community can easily see the new features (with notes) that are in the dev branch since the last release. This will be really helpful for those trying to understand the true functional difference in the branches. (Ongoing release notes was a suggestion from the 22.10 feedback #101 (comment) ) For the above bot-driven process I think it would be useful to keep it label-driven (or something similar) that is easy for everyone to understand that also enables the use case: |
Beta Was this translation helpful? Give feedback.
-
I think this is a feasible and effective idea. It makes good use of the flexible infrastructure GitHub's web interface provides (which has many examples we can pull from to help with development) and appears to integrate into a contributor's workflow with little overhead. Most importantly, this would significantly lessen the overhead put on all teams to track down PRs for release notes. |
Beta Was this translation helpful? Give feedback.
-
Compiling release notes is a manual, long and tedious process which, at its core, consists of analyzing all PRs for changes submitted to development and stabilization since the last release and looking for relevant changes to highlight.
Whether it is centralized on
sig-release
or delegated to be broken up per-sig, it is usually hard to retroactively compile this list after months of development to highlight the relevant changes.A current mechanism to try and minimize the hassle of this process has been to introduce labels to mark PRs containing relevant changes. This has the downside of not being a known or enforced process, though, so it only covers a portion of the changes and reverts to the manual process for the rest of the areas.
It would be valuable to have a system in place, either an established workflow or an automation, to simplify this process for future release in order to make them easier to execute and make it harder to miss relevant features in our communications.
Beta Was this translation helpful? Give feedback.
All reactions