summaryrefslogtreecommitdiff
path: root/puppet/modules/stdlib/RELEASE_PROCESS.markdown
blob: 0f9328ed0fa62572c4d8f4de991876cdbe790076 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 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 vX.Y.Z -m 'version X.Y.Z' (NOTE the
   leading v as per semver.org)
 * Push the tag with git push origin --tags
 * 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.