summaryrefslogtreecommitdiff
path: root/RELEASE_PROCESS.markdown
diff options
context:
space:
mode:
authorJeff McCune <jeff@puppetlabs.com>2011-11-08 14:20:20 -0800
committerJeff McCune <jeff@puppetlabs.com>2011-11-08 14:20:20 -0800
commit198a52af2415cb864ca8e198c39e4cc67f9f6586 (patch)
treea9bd84aaf3248adb409a82b91b18b55e230ff487 /RELEASE_PROCESS.markdown
parent97d1c692f11b841754816d3f83f2c7cebf6e649d (diff)
downloadpuppet-stdlib-198a52af2415cb864ca8e198c39e4cc67f9f6586.tar.gz
puppet-stdlib-198a52af2415cb864ca8e198c39e4cc67f9f6586.tar.bz2
Update the release process instructions.
The release process document didn't really mention semver.org or the rubrics we use to pick version numbers at release. This patch adds some hints about picking a version number and looking for API breaking changes to the code.
Diffstat (limited to 'RELEASE_PROCESS.markdown')
-rw-r--r--RELEASE_PROCESS.markdown14
1 files changed, 12 insertions, 2 deletions
diff --git a/RELEASE_PROCESS.markdown b/RELEASE_PROCESS.markdown
index ea40d5d..99f4f05 100644
--- a/RELEASE_PROCESS.markdown
+++ b/RELEASE_PROCESS.markdown
@@ -1,13 +1,23 @@
-# Releasing this module #
+# Contributing to this module #
* Work in a topic branch
* Submit a github pull request
* Address any comments / feeback
* Merge into master using --no-ff
+
+# Releasing this module #
+
+ * This module adheres to http://semver.org/
+ * Look for API breaking changes using git diff vX.Y.Z..master
+ * If no API breaking changes, the minor version may be bumped.
+ * If there are API breaking changes, the major version must be bumped.
+ * If there are only small minor changes, the patch version may be bumped.
* Update the CHANGELOG
* Update the Modulefile
+ * Commit these changes with a message along the lines of "Update CHANGELOG and Modulefile for release"
* Create an annotated tag with git tag -a X.Y.Z -m 'version X.Y.Z'
* Push the tag with git push origin --tags
- * Build a new package with puppet-module
+ * Build a new package with puppet-module or the rake build task if it exists
* Publish the new package to the forge
+ * Bonus points for an announcement to puppet-users.