You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by al...@apache.org on 2016/11/03 21:49:01 UTC

[4/6] mesos git commit: Updated the release guide with the instructions regarding CHANGELOG.

Updated the release guide with the instructions regarding CHANGELOG.

Review: https://reviews.apache.org/r/53383


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/5c7b9eb5
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/5c7b9eb5
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/5c7b9eb5

Branch: refs/heads/master
Commit: 5c7b9eb58cc3aa1faf7a859d0de195a19f7786e8
Parents: 40cc029
Author: Alexander Rukletsov <al...@apache.org>
Authored: Thu Nov 3 12:02:10 2016 +0100
Committer: Alexander Rukletsov <al...@apache.org>
Committed: Thu Nov 3 22:13:34 2016 +0100

----------------------------------------------------------------------
 docs/release-guide.md | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/5c7b9eb5/docs/release-guide.md
----------------------------------------------------------------------
diff --git a/docs/release-guide.md b/docs/release-guide.md
index cc85993..6ced432 100644
--- a/docs/release-guide.md
+++ b/docs/release-guide.md
@@ -70,9 +70,23 @@ This guide describes the process of doing an official release of Mesos.
 2. Checkout the correct branch for the release. For regular releases this is the "master" branch. For
    patch releases this would be the corresponding release branch (e.g., 1.0.x).
 
-3. Update and commit the `CHANGELOG` for the release. For regular releases we like to call
-   out any major features, API changes, or deprecations at the top of the CHANGELOG. For patch releases
-   update the CHANGELOG on master branch and then cherry pick onto the release branch.
+3. Update and commit the `CHANGELOG` for the release.
+
+   For regular releases:
+
+   * Make sure all new API changes, deprecations, major features, and features
+     graduating from experimental to stable are called out at the top of the
+     `CHANGELOG`.
+
+   * Ensure that the "Unresolved Critical Issues" section is populated
+     correctly. This JIRA query may be helpful:
+     `project = Mesos AND type = bug AND status != Resolved AND priority IN (blocker, critical)`
+
+   * Prepare a full list of experimental features. The easiest way to do this
+     is to take the list from the previous minor release, remove features that
+     have been declared stable, and those, that declared experimental in the
+     current release. Do not forget to mention features transitioning from
+     experimental to stable in this release at the top of the `CHANGELOG`.
 
     > NOTE: You should use JIRA to generate the CHANGELOG for you. Click on the release
       version in [JIRA](https://issues.apache.org/jira/browse/MESOS#selectedTab=com.atlassian.jira.plugin.system.project%3Aversions-panel) and click
@@ -83,6 +97,9 @@ This guide describes the process of doing an official release of Mesos.
       `Target Version` set but not `Fix Version`. Also check for any Unresolved
       or `Duplicate`/`Invalid` tickets that incorrectly set the `Fix Version`.
 
+   For patch releases update the `CHANGELOG` on master branch and then cherry
+   pick onto the release branch.
+
 4. Ensure version in `configure.ac` and `CMakeLists.txt` is correctly set for the release.
 
 5. Run `make && support/generate-endpoint-help.py` and commit any resulting changes.