cederom commented on PR #16823:
URL: https://github.com/apache/nuttx/pull/16823#issuecomment-3210846010
> > If you want to remove breaking mark ("!") from PR titles and leave only
in git commits then I will follow the community voice. Should we vote that
change on the mailing list?
>
> Nobody is proposing it Tomek! The exclamation mark will be needed by the
Release Notes script...
>
> Could you please look at the code Luke!
https://github.com/apache/nuttx/pull/16823/files
Release Notes are generated from **Pull Requests** not git commits:
* See https://nuttx.apache.org/releases/12.10.0/.
* Note the list contains links to Pull Request URL on GitHub. You can click
a number before change title and you are redirected to a Pull Request.
* See the RN generation script
https://github.com/apache/nuttx/blob/master/tools/doreleasenotes.py, the commit
is only used to obtain date not the title.
1. Original requirement text - there is git commit and PR title:
> 9. Breaking Change must be clearly marked with a `[BREAKING]` tag in the
> **git commit topic and PR title** that will propagate to Release Notes.
2. New requirement proposition - no PR title here just git commit:
> Breaking change must be clearly identified with inclusion of an
exclamation mark `!` as the first character of the **commit title** and a
`BREAKING CHANGE:` in the **git commit** log message, followed by a short
comment about how the user should adapt their code. This change
description will be used to create the Release Notes.
3. My proposition - both git commit and PR title as before change:
> Breaking Changes must be clearly marked both in **Git Commits and Pull
Requests**: 1. Put ! (exclamation mark) as first character of the title; 2. Put
BREAKING CHANGE: in the body with a brief change description and the quick-fix
instructions. This helps users identify areas that need an update on their
side, grep git logs, and auto-generate Release Notes.
This "!" (+"BREAKING CHANGE:") mark should be both part of Git Commit and
the Pull Request too as this tells more attention needed here when checking,
and it aligns with existing release process as explained above. This is my last
message about this.
Let @jerpelea decide he is the Release Manager :-)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
