git-flow-buddy

This tool helps building git releases with a changelog and semver versioning. The tool works with composer and node projects. The git-flow-buddy use version property in the package.json or composer.json. You can flag the release with a status e.g. stable, unstable or beta with a status field in the package file.

Requiements

git, git-flow, node, npm

Install

$ npm install --global git-flow-buddy

Usage

Parameters

• -h/--help : show the help
• -p/--push : push new release to origin
• -k/--keep : keep branch after performing finish
• -d/--debug : debug output
• -u/--update : update the last release (experimental)
• -b/--bump : just bump the version, nothing else
• -f/--finish : finish a previously created release branch (useful if finishRelease is set to false)
• -r/--disable-roolback : disable rollback on release fail
• --cleanup : remove an unfinished release
• --reset : reset repo with origin
• --changes : show changes since last version

Examples

$ cd AwesomeProject
$ git flow init     # init git flow (if not yet done) 
$ gfb patch         # create a new (local) patch release - eg 0.0.4 -> 0.0.5
$ gfb -p minor      # create a new minor release and push the release branch and tag to the server - eg 0.2.4 -> 0.3.0
$ gfb --help        # show the help
$ gfb -f 0.6.1      # finish a previously created release

Usage gfb-config.json config files

With the gfb-config.json config files you can configure your build and set some properties to default.

Properties

• push - push new release to origin (default: false).
• keep - keep branch after performing finish (default: false).
• update - update the last release (experimental) (default: false).
• debug - print all called functions (default: false).
• buildTimestampInName - include build Timestamp in release name (default: false).
• createChangelog - create a changelog (default: true).
• changelogFolder - folder where the changelog saved (default: ./changelogs).
• commitURL - repository commit url (default false) e.g. "commitURL": "https://github.com/lotterfriends/git-flow-buddy/commit"
• releaseURL - repository commit url (default false) e.g. "releaseURL": "https://github.com/lotterfriends/git-flow-buddy/releases/tag"
• packageSpaces - spaces in the package.json or composer.json file (default 2),,
• preConditionCommands - commands (as an array) that are executed before the first release action. If en error occure in one of these commands, the release doesn't start e.g. ``"preConditionCommands": ["grunt lintjs", "grunt lintcss"]` (default: [])
• neverendingChangelog - use just one changelog file and prepend the new releases (default: false).
• neverendingChangelogFilename - the filename of the neverending changelog (default: CHANGELOG.md).
• customReleaseCommands - commands (as an array) that are executed after the branch creation and the update of ther version file (package.json, composer.json) and before the release branch commit, if you want to automatically update files or sth. with the commit, this is your place to be (default: [])
• postReleaseCommands - commands (as an array) that are executed after the release. You can use this for example to trigger a notfication hook or to publish a npm package (default: [])
• changelogUsername - user in changelog that created the version (default: auto).
  • Options:
    • env : use content of env variable gfb_release_user
    • git : use git username
    • os : use system username
    • auto : try options till username is not empty, priority -> env, git, os
• finishRelease - execute git release finish (default true)
• postReleaseFinishedCommands - executed after gfb execution with --finish/-f flag instead of postReleaseCommands (default [])
• customReleaseFinishCommands - executed during gfb execution with --finish/-f flag instead of customReleaseCommands (default [])
• releaseMessagePrefix - customize the prefix of the relase message (default new Release)

Other

• If you prefix your commit message with a text and a doubledot, everything before the doubledot is printed bold in the changelog.
• Commits prefixed with one of the following texts are ignored by the changelog generation (case independent)
  • working on
  • wip
  • [wip]
  • (wip)
  • release mgnt
  • [release mgnt]
  • (release mgnt)

License

The MIT License (MIT)

Copyright (c) 2016 André Tarnowsky

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.