...
| Note |
|---|
The update of LICENSE, NOTICE files, and the run of |
Prepare the release notes
| Note |
|---|
Please do not gather all the commit messages and turn that into release notes. |
You need to prepare good release notes that highlights:
- Important features added in the new release.
- Any deprecated configuration or external methods, noting these these may be removed later.
- Any configuration/methods that was deprecated earlier, and have been removed from this release.
- Any special notes for upgrading from previous releases (e.g. for zero-downtime upgrade, please upgrade to release X before this one).
- Other special notes
Here is a command you can use to get all the check-ins since the last release
| Code Block | ||
|---|---|---|
| ||
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
# Assuming 2a3860229 was the commit hash in the master where the previous release was branched off
# Each argument following -- is a directory under pinot source tree (note that we have excluded the 'docs' directory |
Once you have the commits, you are ready to come up with good material for release notes.
Check out staging and release distributions
...
You can also verify from https://github.com/apache/incubator-pinot that a new tag has appeared, and that the commit of the pom files shows up.
Prepare the release notes
| Tip |
|---|
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 |
...