I noticed something while looking at this branch. It seems a bit too greedy when looking for the release notes tag. The script generates the following from its own commit message:
The first, empty entry is coming from this line at the end of a paragraph in the commit message: "release notes."
This could be avoided by making the regex a little tighter by requiring the '-' between "release" and "notes" rather allowing any character, or perhaps there could be a check for the length of the found text with some arbitrary minimum being required. (I'm not sure how short a useful release could be, but I imagine that anything less that 8-10 characters is too short to convey useful information.)
This looks good so far, and I wonder if it could be incorporated into the create_release_note.sh script to make things even easier/more automated.
Barring that, I think an example of using extract_release_notes_from_commits.pl to add to or to start a release notes file would be useful.
I noticed something while looking at this branch. It seems a bit too greedy when looking for the release notes tag. The script generates the following from its own commit message:
* https:/ /bugs.launchpad .net/evergreen/ +bug/2051874[Bug 2051874]: . /bugs.launchpad .net/evergreen/ +bug/2051874[Bug 2051874]: New development tool to help prepare release notes using information from Git commits.
* https:/
The first, empty entry is coming from this line at the end of a paragraph in the commit message: "release notes."
This could be avoided by making the regex a little tighter by requiring the '-' between "release" and "notes" rather allowing any character, or perhaps there could be a check for the length of the found text with some arbitrary minimum being required. (I'm not sure how short a useful release could be, but I imagine that anything less that 8-10 characters is too short to convey useful information.)
This looks good so far, and I wonder if it could be incorporated into the create_ release_ note.sh script to make things even easier/more automated.
Barring that, I think an example of using extract_ release_ notes_from_ commits. pl to add to or to start a release notes file would be useful.