Page History

We already agreed contributions should always go via a PR and require two LGTM’s before we merge. This is the next step: How we should do release management for This page describes the Release Management principles for Apache CloudStack 4.6 and onnewer releases.

Contents:

...

1. Master needs to be stable at all times
2. Pull requests will be merged after 2x LGTM and no -1 (we already agreed on thissee below)
3. When a release is being prepared, master will be “frozen” for new features (we aim to keep this window as short as possible)
4. Release branch will be branched off of master as soon as a release candidate (RC) vote passes (no more QA on release branches before release)
5. Bug fixes should be fixed on a release branch first, then merged forward to the next release (if any) and finally master. No more cherry-picking!to master.
   Important: The commit hashes from the Pull Request should stil be the same in all branches this commit is in (cherry-picking cannot do this).
6. Only bug fixes will be fixed in release branches, there will be no back porting of new features
7. We should all use the same scripts to merge pull requests and do forward merges. The tools will be put are located in the CloudStack repository.

Goal written in “Scrum”-style story

...

 *Coverage may go down if code that was covered is deleted

Overview of release process

...

• when voted in, x.y.0 is released and the RC-branch will become x.y branch and the commit that has been voted on, i.e. the head of branch x.y, tagged x.y.0
  Image Removed
  Image Added

Preparing new release: master frozen

...

• Once x.y.0 is released, master will be opened for new feature merges. The Release Managers announce this on the list (usually a few days are needed to finalise the release and prepare the branches for the next release).
• When the new features are in, master will be frozen again, etc.
• It is expected that the new version can go out soon, as we start off from an already stable master at the exact point the previous release was made.

...

• Development should be done in a feature branch, branched off of master
• Send a PR to get it into master (2x LGTM applies), represented by the 'merge PR' arrows below
• Will only be merged when master is open, will be held otherwise until master is open again
• No back porting / cherry-picking features to existing branches!

How to merge a Pull Request?

See this wiki article for a guide on how to do it.

Why merging forward over cherry-picking from master?

...

wiki with detailed info here

Git commands:

# Get the exact same commits from the pull-request (the commit hashes must not change)
git fetch origin pull/${prId}/head:pr/${prId}
 
# Commit it without fast-forwarding. Type the commit message as detailed below.
git merge --no-ff --log pr/${prId}


# Finally, sign the merge commit.
git commit --amend -s --allow-empty-message -m ''

An optional helper script with detailed usage and help can be found here.

Scenario 2: Merging a pull request to a release branch

wiki with detailed info here

# Make sure you're on the branch you want to merge into
git checkout ${branch}

# Merge to the next branch and type the commit message as described below.
git merge --no-ff --log ${branch_to_merge}
 

An optional helper script with detailed usage and help can be found here.

More info on this wiki page.

Commit messages

Merging a pull request

The commit message for a merging a pull request, should look like this:

 Merge pull 

request

request #{pr number} from 

@

@ {user name of pr author}

 

{pr title}

* pr/{pr number}:
  {list of commit messages}

Signed-off-by: {name and email of ACS committer that merges the pr}

It is important the pull request is merged to the branch. This script will help you do that (it will be added to the CloudStack repository).

Usage: 

./merge-pr.shgit pr 1234

Detailed usage and help can be found here.

...

It is important the pull request is forward merged to the next branch. This script will help you do that (it will be added to the CloudStack repository).

Usage: 

./forwardgit fwd-merge.sh some-branch

Detailed usage and help can be found here.

Gotcha: working with two origin repositories

When using these tools and this way of working on Apache CloudStack keep in mind that you work with two origins:

1. git-wip-us.apache.org/repos/asf/cloudstack.git (read/write)
2. and github.com/apache/cloudstack.git (read-only)

If you merge on a clone of one of them while it is behind on the other (or with its origin) you are merging on a commit that is no longer a HEAD. You will get an error when you push due to conflicts. At this point it is safest to throw away your merge, update (git fetch) you local clones and merge the PR again.

Initial merge of release branch to master

Originally written by Rajani Karuturi in PR 1071:

Initial merge of 4.6 to master
ignored pom.xml version number changes and changes to debian/changelog and engine/schema/src/com/cloud/upgrade/DatabaseUpgradeChecker.java
Following commands were executed
1. git checkout 4.6
2. git pull --rebase
3. git checkout master
4. git pull --rebase
5. git fwd-merge 4.6
6. git diff --name-only | grep pom.xml | xargs git checkout --ours
7. git diff --name-only | grep pom.xml | xargs git add
8. git checkout --ours engine/schema/src/com/cloud/upgrade/DatabaseUpgradeChecker.java
9. git add engine/schema/src/com/cloud/upgrade/DatabaseUpgradeChecker.java
10. git checkout --ours debian/changelog
11. git add debian/changelog
12. # manually edited version number in tools/marvin/marvin/deployAndRun.py and tools/marvin/setup.py
13. git commit
14. git checkout -b "merge-46-to-master"
Send this as a PR

Monthly release schema

The monthly release schema looks like this:

Day 1: release of 4.x.0

Day 14: release of 4.x.1

Day 14: feature freeze 4.(x+1).0

Day 21: 4.(x+1).0 RC

Day 28: release of 4.x.2

Release management for 4.6

Based on these principles, Rajani Karuturi and Remi Bergsma volunteered to be the Release Managers of Apache CloudStack 4.6.

Release management for 4.

...

7

Thanks

History of this document

This is the original diagram of the release process that was included on which we started the DISCUSS (added for archiving purposes)

Image Removed

...

Thanks to Rajani Karuturi, Daan, Miguel Ferreira, Wilder Rodrigues and all others for working on this with me (Remi Bergsma).

...