Hi all,

For several past releases I have tweaked the scripts to automatically build the 
release notes based on the available metadata, rather than manually sifting 
through the commits.
Today I want to share a “just-in-time” version of it. The below URL gives the 
answer to the question “what would the release notes for the next release look 
like if we were to do the release today?”:

https://github.com/vpp-dev/vpp-release-notes

The idea is that the “next version” is extracted from the latest tag on the 
branch (in this case master), and the script runs through the entire process 
including the extraction of the API changes and deprecations, etc.

This results in the generated release notes, updated daily on schedule by a 
GitHub action.

After that, the script looks if there is a file named with the corresponding 
version, and treats it as a sed script - resulting in “retouched” release notes 
file. This action gets triggered on push. So one can update the sed file and 
immediately see the result.

This gives a way to edit the release note in a way that is repeatable and makes 
it obvious what and how was edited - and by the time of the next RC1, the 
release note is already done, will just need to be copied for the review and 
final edits before the branch fork...

Will be happy to hear feedback... :-)

--a
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#17653): https://lists.fd.io/g/vpp-dev/message/17653
Mute This Topic: https://lists.fd.io/mt/77339504/21656
Group Owner: vpp-dev+ow...@lists.fd.io
Unsubscribe: https://lists.fd.io/g/vpp-dev/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-

Reply via email to