git-release 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+
+before_script:
+    - git config --global user.email "testing-git-release@example.com"
+    - git config --global user.name "Testing git-release git user"
+
+script:
+    - echo $(bash --version)
+    - test/bin/run_all

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git-release.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Meier
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# Git-Release (BETA - work in progress)
+
+Bash only (language agnostic) git release script for tagging and bagging a release candidate with changelog text generation
+
+[![Build Status](https://travis-ci.org/tommeier/git-release.png)](https://travis-ci.org/tommeier/git-release)
+
+This project performs two simple tasks:
+
+  * Generate a changelog based on git commits and tag with a custom tag prefix
+  * Generate a changelog based on git commits at deploy time and tag with a custom deploy tag prefix
+
+Everything is configurable via command line parameters. Run with help command (`-h`) to list all possible configurations.
+
+## Dependencies
+
+  * Git
+  * Bash (Mac OSX / *nix )
+  * Grep
+
+## Installation
+
+This is the base language agnostic script. Git clone this repo somewhere on your system and ensure the `git-release` and `git-release-deployed` bin files are accessible in the PATH.
+
+## Looking for?
+
+Additional implementations using this base script to wrap functionality and share across languages:
+
+  * Ruby (coming soon)
+  * Python (coming soon)
+  * Node NPM (coming soon)
+
+## Example flow
+
+The usage flow for this app is as follows:
+
+  * Run `git-release` at the end of a release cycle defining whether it is a major, minor or patch release. This generates a `CHANGELOG` in the root of the projet, and a `VERSION` file with content. If you've released before, this will find the last release and generate changelog and version number accordingly. A tag will be generated for this release with the generated changelog.
+
+  * During the deploy of this release tag, run `git-release-deployed` on successful deployment. This will generate a new changelog, compared to the last deploy. The reason for this is simple. You may create many releases, but only some versions hit different environments. For example, you create release 0.0.1, deploy to staging, fix many issues, then deploy to production with all the additional fixes. The changelog for staging, for each release, is very different to that of production with all the changes grouped together.
+
+## Version file
+
+This file simple contains the raw version number (e.g. `1.4.21`). Useful for parsing in a deployed app to display the current version number. In some applications I use this to provide a `meta` tag with the version information.
+
+## Changelog file
+
+Generation is based on all git commits between a start and end point ordered by recency. With nothing provided, by default, the scripts will work out the last commit for a tag prefix, or last deploy and generate up to HEAD.
+
+Developers that follow feature branches can pass an optional parameter to generate the changelog only on the pull requests merged in (the 'epics') providing a much cleaner list of content.
+
+Tagged content of the changelog is limited at the moment, I'm looking at ways to make this dynamic. But right now, any commit with the following prefixes (ignoring spaces and case) will group the commits in the `CHANGELOG` and present under ordered headings:
+
+   * `[feature]`
+   * `[security]`
+   * `[bug]`
+
+## Deploy
+
+After a deploy running `git-release-deployed` with the release tag passed in provides the ability to generate the changelog based only on the last deploy. With a custom deploy prefix, for example `deployed/staging` you can scope the changelog to a given environment.
+
+## Full examples
+
+### Git-Release
+
+Release with defaults (first time):
+```
+$> git-release -v 'minor'
+```
+Generates:
+  * version file: `0.1.0`
+  * tag         : `release/v0.1.0`
+  * Changelog   : all commits text up until now
+
+---
+
+Release with defaults (second time):
+```
+$> git-release -v 'major'
+```
+Generates:
+  * version file: `1.1.0`
+  * tag         : `release/v1.1.0`
+  * Changelog   : all commits between last release and this one
+
+---
+
+Release with only pull requests for changelog generation:
+```
+$> git-release -v 'major' -P
+```
+Generates:
+  * version file: `1.1.0`
+  * tag         : `release/v1.1.0`
+  * Changelog   : all merged pull requests and the body text of the merge commit
+
+(TODO: git-release-deployed info)
+
+## Contributing
+
+All fork + pull requests welcome!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Ensure all tests still run
+6. Create new Pull Request
+
+To run the tests locally:
+
+```Bash
+
+$> test/bin/run_all
+
+```
+
+## TODO
+
+ - [ ] Merge capture and help text into language agnostic file, so ruby can load in ruby and return loaded ENV variables
+ - [ ] Create remaining TODO items as issues in Github
+ - [ ] Test mode should display processes it would run (--dry-run option)
+ - [ ] Change output of script to hide most output (unless dry run activated)
+ - [ ] Create Ruby gem branch and release as a gem. Use better OPTPARSER to use more human readable variables to pass to - der lying  script
+ - [ ] Create Node NPM branch and release as an NPM.
+ - [ ] Create Python PIP branch and release as a PIP.
+ - [ ] Test on variety of systems and servers
+ - [ ] [potentially] Fix issue in tests where the time can very rarely cross over a second boundary (make specs ignore seconds difference)
+ - [ ] [potentially] Change git-release to work out prefix if given a start or an end point and no prefix
+ - [ ] [potentially] Make test helpers for generating the content (changing the style now will break a lot of tests)
+ - [ ] [potentially] Make CHANGELOG tagging dynamic (search for initial square brackets), with features + bugs on top of listing
+ - [ ] [potentially] Make CHANGELOG generation read in optional template, with wildcards to apply logic to view
+ - [ ] [potentially] Work out how to test git push being fired, mocking a git command
+ - [ ] [potentially] Use an left pad command to align help text correctly
+ - [*] Add full examples to Readme
+ - [*] Optionally force push of tags, otherwise ask for confirmation to send
+ - [*] Remove the 'skip execute' code
+ - [*] Create language maps (bash first, to make ruby only etc) for argument naming. Use everywhere in specs
+ - [*] Make test helpers for setting argument mapping (for easily changing in other wrappers)
+ - [*] Review argument naming and choose better letters
+ - [*] Remove unnessary $(output)= statements in tests
+ - [*] Update git-release to remove the division of release and version prefix, make just one prefix (simpler)
+ - [*] Write success cases for git-release-deployed script
+ - [*] Split up functions and specs into more logical divisions (changelog, git) rather than one large support file
+ - [*] Remove *.sh filenames and rely on shebangs on each executable file. Support files keep for editors to use.
+ - [*] Split into seperate github repo with migrated history
+ - [*] Load Travis-CI
+
+
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/git-release

@@ -0,0 +1,135 @@
+#!/bin/bash -e
+set -e
+
+############################################################
+#####                  Git-Release                     #####
+### Pure bash script for handling git release versioning ###
+############################################################
+
+
+############################################################
+#####                   DEFAULTS                       #####
+############################################################
+
+RELEASE_PREFIX='release/v'
+CHANGELOG_FILE='CHANGELOG'
+VERSION_FILE='VERSION'
+CHANGELOG_SCOPE=':all_commits'
+CHANGELOG_STRATEGY=':overwrite'
+
+START_POINT=''
+END_POINT=''
+
+#Supporting functions
+. "${BASH_SOURCE[0]%/*}/../support/support-functions.sh"
+
+USAGE_OUTPUT="
+usage : $(basename "$0") $(arg_for $ARG_VERSION '<version>') [$(arg_for $ARG_RELEASE_PREFIX '<prefix>')] [$(arg_for $ARG_START '<start>')] [$(arg_for $ARG_FINISH '<finish>')]
+                         [$(arg_for $ARG_APPEND)] [$(arg_for $ARG_FORCE)] [$(arg_for $ARG_PULL_REQUESTS)] [$(arg_for $ARG_CHANGELOG '<changelog_file>')] [$(arg_for $ARG_VERSION_FILE '<version_file>')]
+                         [$(arg_for $ARG_HELP_TEXT)]
+                         --- create git release tag with changelog
+
+options:
+  required:
+    $(arg_for $ARG_VERSION '<version>')  set the software versioning type (major or minor or patch)
+  optional:
+    [$(arg_for $ARG_RELEASE_PREFIX '<prefix>')] set the release prefix (default: '${RELEASE_PREFIX}')
+    [$(arg_for $ARG_FORCE)]            force push of new tags (default: commit changes but do not push)
+  changelog:
+    [$(arg_for $ARG_START '<start>')]  set the start point (default: the last tag name that matches the prefix)
+    [$(arg_for $ARG_FINISH '<finish>')] set the end/finish point (default: HEAD)
+    [$(arg_for $ARG_APPEND)]            append to changelog (default: ${CHANGELOG_STRATEGY})
+    [$(arg_for $ARG_PULL_REQUESTS)]            set to only pull requests (default: ${CHANGELOG_SCOPE})
+    [$(arg_for $ARG_CHANGELOG '<changelog_file>')] set the changelog filename (default: ${CHANGELOG_FILE})
+    [$(arg_for $ARG_VERSION_FILE '<version_file>')] set the version file name (default: ${VERSION_FILE})
+  general:
+    $(arg_for $ARG_HELP_TEXT)  show this help text
+
+
+usage examples:
+
+  1) Basic usage with defaults
+    Given the last release was at 1.0.4, with a tag of 'our-releases/REL1.0.4' :
+
+    $(basename "$0") $(arg_for $ARG_VERSION 'minor') $(arg_for $ARG_RELEASE_PREFIX 'our-releases/REL-')
+
+    Tag generated           : our-releases/REL1.1.4
+    Version file contains   : 1.1.4
+    CHANGELOG file contains : commit information for all commits between last release and HEAD
+
+  2) Pull requests only (changelog generated only with body of pull request titles)
+
+    $(basename "$0") $(arg_for $ARG_VERSION 'minor') $(arg_for $ARG_PULL_REQUESTS)
+
+  3) Generate custom changelog and version file
+
+    $(basename "$0") $(arg_for $ARG_VERSION 'minor') $(arg_for $ARG_CHANGELOG 'MYCHANGELOGFILE') $(arg_for $ARG_VERSION_FILE 'MYVERSIONFILE')
+
+"
+
+############################################################
+#####                  INPUT CAPTURE                   #####
+############################################################
+
+while getopts "$ARG_FORCE""$ARG_HELP_TEXT""$ARG_APPEND""$ARG_PULL_REQUESTS""$ARG_VERSION":"$ARG_START":"$ARG_FINISH":"$ARG_RELEASE_PREFIX":"$ARG_CHANGELOG":"$ARG_VERSION_FILE": option
+do
+  case "${option}"
+  in
+    $ARG_HELP_TEXT)
+      echo "$USAGE_OUTPUT" >&2
+      exit 0
+      ;;
+    $ARG_PULL_REQUESTS) CHANGELOG_SCOPE=":pulls_only";;
+    $ARG_APPEND) CHANGELOG_STRATEGY=":append";;
+    $ARG_FORCE) FORCE_PUSH='true';;
+    $ARG_VERSION) VERSION_TYPE="$OPTARG";;
+    $ARG_RELEASE_PREFIX) RELEASE_PREFIX="$OPTARG";;
+    $ARG_START) START_POINT="$OPTARG";;
+    $ARG_FINISH) END_POINT="$OPTARG";;
+    $ARG_CHANGELOG) CHANGELOG_FILE="$OPTARG";;
+    $ARG_VERSION_FILE) VERSION_FILE="$OPTARG";;
+
+    ?)
+      printf "illegal option: '%s'\n" "$OPTARG" >&2
+      echo "$USAGE_OUTPUT" >&2
+      exit 1
+      ;;
+  esac
+done
+shift $((OPTIND - 1))
+
+############################################################
+#####                  VALIDATION                      #####
+############################################################
+
+validate_version_type "$VERSION_TYPE" "$USAGE_OUTPUT"
+ensure_git_directory
+ensure_git_is_clean
+
+############################################################
+#####                   RELEASE                        #####
+############################################################
+last_tag_name=$(get_last_tag_name $RELEASE_PREFIX);
+
+if [[ "$START_POINT" = '' ]]; then
+  START_POINT=$last_tag_name
+fi;
+
+next_version_number=$(get_next_version_number_from_tag $VERSION_TYPE $last_tag_name)
+next_tag_name="${RELEASE_PREFIX}${next_version_number}"
+generate_version_file "$next_version_number" "$VERSION_FILE"
+
+changelog_content=$(generate_changelog_content "$next_version_number" "$CHANGELOG_SCOPE" "$START_POINT" "$END_POINT")
+
+generate_changelog_file "$changelog_content" "$CHANGELOG_STRATEGY" "$CHANGELOG_FILE"
+
+set +e #Allow commit to fail if no files have changed
+git add -A
+git commit -m "Release : ${next_tag_name}"
+set -e
+
+git tag $next_tag_name
+
+if [[ "$FORCE_PUSH" = 'true' ]]; then
+  git push $next_tag_name
+fi;

data/bin/git-release-deployed

@@ -0,0 +1,140 @@
+#!/bin/bash -e
+set -e
+
+############################################################
+#####               Git-Release-Deployed               #####
+###   Pure bash script for handling deployed releases    ###
+###       Providing a tag with generated changelog       ###
+############################################################
+
+############################################################
+#####                   DEFAULTS                       #####
+############################################################
+
+DEPLOYED_PREFIX='deployed/'
+CHANGELOG_FILE='CHANGELOG'
+CHANGELOG_SCOPE=':all_commits'
+CHANGELOG_STRATEGY=':overwrite'
+
+START_POINT=''
+END_POINT=''
+
+#Supporting functions
+. "${BASH_SOURCE[0]%/*}/../support/support-functions.sh"
+
+USAGE_OUTPUT="
+usage : $(basename "$0") $(arg_for $ARG_DEPLOYED_TAG '<deployed_tag>') [$(arg_for $ARG_RELEASE_PREFIX '<prefix>')] [$(arg_for $ARG_START '<start>')] [$(arg_for $ARG_FINISH '<finish>')]
+                         [$(arg_for $ARG_APPEND)] [$(arg_for $ARG_FORCE)] [$(arg_for $ARG_PULL_REQUESTS)] [$(arg_for $ARG_CHANGELOG '<changelog_file>')]
+                         [$(arg_for $ARG_HELP_TEXT)]
+                         --- create git release tag for a deployed release with a generated changelog.
+
+options:
+  required:
+    $(arg_for $ARG_DEPLOYED_TAG '<deployed_tag>') set the deployed tag name
+  optional:
+    [$(arg_for $ARG_RELEASE_PREFIX '<prefix>')]     set the prefix for the new deployment tag (default: '${DEPLOYED_PREFIX}')
+    [$(arg_for $ARG_FORCE)]            force push of new deploy tag (default: commit changes but do not push)
+  changelog:
+    [$(arg_for $ARG_START '<start>')]      set the start point (default: the last deployed tag)
+    [$(arg_for $ARG_FINISH '<finish>')]     set the end/finish point (default: HEAD)
+    [$(arg_for $ARG_APPEND)]                append to changelog (default: ${CHANGELOG_STRATEGY})
+    [$(arg_for $ARG_PULL_REQUESTS)]                set to only pull requests (default: ${CHANGELOG_SCOPE})
+    [$(arg_for $ARG_CHANGELOG '<changelog_file>')]   set the changelog filename (default: ${CHANGELOG_FILE})
+  general:
+    [$(arg_for $ARG_HELP_TEXT)]  show this help text
+
+
+usage examples:
+
+  1) Basic usage with defaults
+    Given the last deployed release was 'releases/v1.1.4' :
+
+    $(basename "$0") $(arg_for $ARG_DEPLOYED_TAG 'releases/v1.1.4') $(arg_for $ARG_RELEASE_PREFIX 'deploys/staging')
+
+    Tag generated           : deploys/staging/our-releases/REL1.1.4
+    CHANGELOG file contains : commit information for all commits between last deployed version and current release
+
+  2) Pull requests only (changelog generated only with body of pull request titles)
+
+    $(basename "$0") $(arg_for $ARG_DEPLOYED_TAG 'releases/v1.0.4') $(arg_for $ARG_PULL_REQUESTS)
+
+  3) Generate custom changelog for deployed versions
+
+   $(basename "$0") $(arg_for $ARG_DEPLOYED_TAG 'releases/v1.0.4') $(arg_for $ARG_CHANGELOG 'DEPLOYEDCHANGELOG')
+
+"
+
+############################################################
+#####                  INPUT CAPTURE                   #####
+############################################################
+
+while getopts "$ARG_FORCE""$ARG_HELP_TEXT""$ARG_APPEND""$ARG_PULL_REQUESTS""$ARG_DEPLOYED_TAG":"$ARG_START":"$ARG_CHANGELOG":"$ARG_FINISH":"$ARG_RELEASE_PREFIX": option
+do
+  case "${option}"
+  in
+    $ARG_DEPLOYED_TAG) DEPLOYED_TAG="$OPTARG";;
+    $ARG_RELEASE_PREFIX) DEPLOYED_PREFIX="$OPTARG";;
+    $ARG_START) START_POINT="$OPTARG";;
+    $ARG_FINISH) END_POINT="$OPTARG";;
+    $ARG_APPEND) CHANGELOG_STRATEGY=":append";;
+    $ARG_FORCE) FORCE_PUSH='true';;
+    $ARG_PULL_REQUESTS) CHANGELOG_SCOPE=":pulls_only";;
+    $ARG_CHANGELOG) CHANGELOG_FILE="$OPTARG";;
+    $ARG_HELP_TEXT)
+      echo "$USAGE_OUTPUT" >&2
+      exit 0
+      ;;
+    ?)
+      printf "illegal option: '%s'\n" "$OPTARG" >&2
+      echo "$USAGE_OUTPUT" >&2
+      exit 1
+      ;;
+  esac
+done
+shift $((OPTIND - 1))
+
+############################################################
+#####                  VALIDATION                      #####
+############################################################
+
+ensure_git_directory
+ensure_git_is_clean
+validate_deploy_tag "$DEPLOYED_TAG" "$USAGE_OUTPUT"
+
+############################################################
+#####                RELEASE-DEPLOYED                  #####
+############################################################
+
+#Checkout existing deployed tag
+next_deploy_tag_name="${DEPLOYED_PREFIX}${DEPLOYED_TAG}"
+
+if [[ $(check_tag_exists "$next_deploy_tag_name" && echo $?) = "0" ]]; then
+  #Delete existing
+  git tag -d $next_deploy_tag_name
+fi;
+git checkout -f --no-track -B "$next_deploy_tag_name" "$DEPLOYED_TAG"
+
+#Capture versioning prefix from new deploy tag
+versioning_prefix=$(get_versioning_prefix_from_tag "$next_deploy_tag_name")
+
+#Find last deployed tag for this versioning style
+last_tag_name=$(get_last_tag_name $versioning_prefix)
+
+deployed_version_number=$(get_version_number_from_tag "$next_deploy_tag_name")
+if [[ "$START_POINT" = '' ]]; then
+  START_POINT=$last_tag_name
+fi;
+
+changelog_content=$( generate_changelog_content "$deployed_version_number" "$CHANGELOG_SCOPE" "$START_POINT" "$END_POINT" )
+
+generate_changelog_file "$changelog_content" "$CHANGELOG_STRATEGY" "$CHANGELOG_FILE"
+
+#Create tag and optionally push
+git add -A
+git commit -m "Release deployed : ${DEPLOYED_TAG}"
+
+git tag -f $next_deploy_tag_name
+
+if [[ "$FORCE_PUSH" = 'true' ]]; then
+  git push $next_deploy_tag_name
+fi;