This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • CloudMonkey Release Procedure
Skip to end of metadata
Go to start of metadata

This page describes the steps that a release manager needs to take to perform a release of Apache CloudStack's CloudMonkey CLI tool.


  1. Ensure that you are working on the correct branch
  2. Set the release version # for the branch in cloudmonkey/
  3. Confirm that the information in is current
  4. Confirm that the information in LICENSE and NOTICE are current
  5. Update the CHANGES file with the critical changes introduced in the release (Be sure to highlight any changes the break backward compatibility)
  6. Remove "version has not been released" warnings from the CHANGES file
  7. Ensure that the CHANGES file in your release branch is synced with the version in the master branch (which may have a future release already in it)

Getting Community Consensus

Prior to an official vote, start a thread on the cloudstack-dev mailing list, specifically asking for comments on the project's readiness to cut a release.

Once it appears that any outstanding blockers have been addressed, you can proceed to the next step.

Preparing a Release

Update your local git repo's master branch from the ASF repository:

git fetch origin

Make sure your local copy exactly matches the remote repo:

git reset --hard HEAD
git clean -qfxd
git rebase origin/master

Then run the source build script (Replacing the parameters: X.X.X=your official version number for the release; CCCC=the GPG Key to sign both the artifacts and the git tag with):

./ -v X.X.X -c -t

( optionally specifying your local directory layout - see -h for details )

This will automatically commit (the -c) to the cloudstack dist dev folder.

Get the commit-sh to vote against for your VOTE email (comes from the command above in a line like this: completed.  use commit-sh of b25d27d80b62de3408041821aa99e68712ae2728 when starting the VOTE thread )

Test the Build

Follow the instructions documented in your release branch's test procedures wiki page.

If your personal tests pass, you are ready to propose the release to the community.

Managing the Vote(s) VOTE

Email the mailing list, using the following template:

SUBJECT: [VOTE] Release Apache CloudStack CloudMonkey X.X.X


Hi All,

I've created a X.X.X release of CloudMonkey, with the following artifacts up for a vote:

Git Branch and Commit SH:;a=shortlog;h=refs/heads/X.X

List of changes:;a=blob_plain;f=CHANGES;hb=X.X

Source release (checksums and signatures are available at the same

PGP release keys (signed using XXXXXXXX):

Vote will be open for 72 hours.

For sanity in tallying the vote, can PMC members please be sure to indicate "(binding)" with their vote?

[ ] +1  approve
[ ] +0  no opinion
[ ] -1  disapprove (and reason why) Voting Results

After 72 hours, the vote can be closed.  

If (after tallying the vote) the binding +1 votes are not in the majority, the issues noted need to be addressed and process starts again. You need to send out a results email (or a less formal abort email) for the VOTE thread.

If the vote passes, then send a [RESULTS] vote to the dev list.  Template below:

SUBJECT: [RESULT][VOTE] Apache CloudStack X.X.X


Hi all,

After 72 hours, the vote for CloudStack CloudMonkey X.X.X [1] *passes* with
Z PMC + Z non-PMC votes.

+1 (PMC / binding)
* person

+1 (non binding)
* person



Thanks to everyone participating.

I will now prepare the release announcement to go out after 24 hours to give the mirrors time to catch up.

Publish the Release

Set the HEAD version numbers to the next release number

Edit cloudmonkey/ to set the new version number.

Push the release tag

The release should have already been tagged in your local repo when you used the script (the -t option).  However, you need to push that tag once the VOTE passes:

$ git push origin tags/X.X.X

Move the release from "dev" to "release"

Move the release artifacts into place (replace X.X.X with the release number, and replace Y.Y.Y with the previous release number):

# svn mv -m "Publishing X.X.X release"

Wait 24 hours for the mirrors to catch up. Note that only a PMC member can move the artifact to the release location.

Update to point to the new release, and add the older release to the archive list.

Remove the prior release from the release dist area (it's still archived):

# cd /tmp/cs-release/releases
# svn rm Y.Y.Y
# svn commit -m "Removing Y.Y.Y release"

Publish the sdist artifact to pypi

First, make sure that you are a package owner of the cloudmonkey package on pypi. Ask a current owner to add you if you aren't one yet.

Build from the tag:

# cd ~/cloudstack-cloudmonkey
# git checkout X.X.X
# python sdist
# gpg -v --armor --output dist/cloudmonkey-X.X.X.tar.gz.asc --detach-sig dist/cloudmonkey-X.X.X.tar.gz

Now log into pypi and create a new release (source artifact).

Be sure to include the dist/cloudmonkey-X.X.X.tar.gz.asc file as the signature.

Set the new release number (assume minor increment)

# cd ~/cloudstack-cloudmonkey
# git checkout master
# vi cloudmonkey/

Edit the _version_ variable at the top of cloudmonkey/ and then commit / push the change.

Announcing the Release

After waiting 24 hours for the ASF mirrors to catch up, the release is ready to be announced. Send separate announcement emails to,,, and  This is best done using your address, so that the announcement gets moderated through to the lists.

The contents of the message should have been discussed on first.

  • No labels