Adding some instructions.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/37389060 Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/37389060 Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/37389060 Branch: refs/heads/master Commit: 373890609833a332002c4fe9cd18cf4c2761ebf5 Parents: 1d09266 Author: Dave Johnson <[email protected]> Authored: Thu Nov 20 11:15:09 2014 +0100 Committer: Dave Johnson <[email protected]> Committed: Thu Nov 20 11:15:09 2014 +0100 ---------------------------------------------------------------------- README.txt | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/37389060/README.txt ---------------------------------------------------------------------- diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..0f81a02 --- /dev/null +++ b/README.txt @@ -0,0 +1,37 @@ + +This directory contains scripts for generating the files and emails needed to +create a Usegrid release and a release-candidate, and for publishing the +release to the proper location for release and mirroring. The scripts are +based on scripts from the Apache Aurora project. + +These are the important files: + + /.usergridversion - version number to be used for release + /.gitattributes - lists file patterns that are to be exlcuded + /release/release-candidate.sh - create a release candidate + /release/release.sh - create a release + /release/changelog.rb - generate CHANGELOG based on JIRA fixVerison + +To create a release candidate: + +1) Change to the master branch. Set .usergridversion to release version number. + +2) Make sure that all JIRA issues that you want in the CHANGELOG have fixVersion + that matches the release version number in .usergridversion + +3) Ensure that everything is committed, branch must be clean + +4) From the project root directory run release/release-candidate.sh + + +To create a release: + +1) Change to the release branch. Set .usergridversion to release version number. + +2) Make sure that all JIRA issues that you want in the CHANGELOG have fixVersion + that matches the release version number in .usergridversion + +3) Ensure that everything is committed, branch must be clean + +4) From the project root directory run release/release.sh +
