...
Prepare the release notes
| Note |
|---|
Please do not gather all the commit messages and turn that into release notes. |
...
Once you have the commits, you are ready to come up with good material for release notes.
Draft the release notes in a text file (in markdown syntax) and keep it ready. You will need it in a later step.
Check out staging and release distributions
...
| Info |
|---|
The mvn release:prepare command seems to remember if it has completed this step (not sure where the cursor is stored). So, you may want to use the option resume=false if you need to invoke it again for some reason. You will also need to remove the commits that this command pushes, locally as well as remote in that case. |
re-
After completion of the command above , you should see two commits on your release branch that look like this (example for 0.2.0 release)
...
Prepare the release notes
...
To get all the commit since previous release, you can execute a command like this (watch for any new directories that may appear in the pinot source tree). You will need to prepare a summary of these, expanding on items that need explanation. Be sure to highlight any backward incompatible situations, etc. Refer to release notes for 0.2.0 when in doubt.
git log 2a3860229^.. -- pinot-api -- pinot-azure-filesystem -- pinot-broker -- pinot-common -- pinot-connectors -- pinot-controller -- pinot-core -- pinot-hadoop -- pinot-hadoop-filesystem -- pinot-minion -- pinot-orc -- pinot-parquet -- pinot-server -- pinot-tools -- pinot-transport- Draft the release notes in a text file (in markdown syntax) and keep it ready. You will need to cut-paste this in this stepCut-paste the release notes. (DO NOT list the entire commit log for release notes).
- The new tag created during the release-preparation step above will automatically show up on https://github.com/apache/incubator-pinot/release. Click "Draft a new release" button, put "tag version" as the one you used from the previous step (e.g. release-0.2.0-rc0). Change the branch field to your release branch.
- Fill in the release note (cut/paste)
- Be sure to check the "This is a pre-release" box.
- Publish the release.
...