Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.59 KB

File metadata and controls

40 lines (26 loc) · 1.59 KB

What is this ?

These are the in-progress release notes for the "next" VPP release.

The next release number is determined from vXX.YY-rc0 tag that has been laid on master branch. It may or may not be actual release number, so do not take it as a commitment unless it has been confirmed at the VPP Community meeting!

How it works ?

There are two github actions, one which generates the RELEASE-GENERATED.md, and is run on a daily basis. It automatically builds the release notes based on the information - commits and MAINTAINERS file - from the VPP repository, and pushes the result to this repository.

The second action, which is run on push (thus also after the first one) or on demand, applies vXX.YY.sed command script to the RELEASE-GENERATED.md, and puts it into RELEASE.md, which is rady to be merged into the VPP's RELEASE.md file. It also merges the HOW-IT-WORKS.md and RELEASE.md into README.md to save you an extra click. It does not push the repo if there were no changes made, to avoid an infinite loop.

How to edit ?

Clone this repo, edit the vXX.YY.sed file, submit a pull request, or just push if you have the access.

Yes, you need to know sed, but it's probably just search-replace, which are "s/what-to-search/what-to-replace-with/", so should not be too hard hopefully.

WARNING: you might need to do a rebase if the RELEASE* files get updated by the automatic jobs in the meantime. Just do: "git fetch; git rebase FETCH_HEAD" if your push fails.

Who do I give the kudos and complaints to ?

Andrew Yourtchenko ayourtch@gmail.com or @ayourtch on twitter

Draft Release Notes below