gitflow-easyrelease 0.3.2

Shortcuts for git flow release with semver support

gitflow-easyrelease aims to streamline git flow release commands. It adds some semver shortcuts as well.

Contents

• Installation

• Usage

• Positionals

  • version

  • base

• Commands

  • init

  • quick

  • start

  • finish

  • publish

  • delete

• Roadmap

  • Main Features

  • Eventual Features

Installation

$ pip install --user gitflow-easyrelease

Usage

$ export PATH=~/.local/bin:$PATH
$ which git-easyrelease
~/.local/bin/git-easyrelease
$ git easyrelease
< should print the main help >
$ git easyrelease --all-help
< dumps all the help >

Positionals

version

version can be one of the following:

• p, patch, or ~ for a patch bump

• m, minor, or ^ for a minor bump

• M or major for a major bump

• X.Y.Z for a new, unconnected semver version

• <any string> for a not semver version

base

base is an optional branch to use as the base for the release. It requires the extended gitflow-avh, but it’s totally optional and shouldn’t break anything if you both don’t have gitflow-avh and never use base.

Commands

init

git easyrelease init [base]

Convenience method to seed the release with 0.0.0. It runs

$ git flow release start 0.0.0 <base>
$ git flow release finish

quick

git easyrelease quick version [base]

Convenience method to start and finish a release branch. It runs

$ git flow release start <version> <base>
$ git flow release finish

start

git easyrelease start version [base]

Extends git flow release start with extra semver functionality. It runs

$ git flow release start <version> <base>

finish

git easyrelease finish [version]

Extends git flow release finish with extra semver functionality. Without version, it attempts to finish the active branch. It runs

$ git flow release finish <version>

publish

git easyrelease publish [version]

Extends git flow release publish with extra semver functionality. Without version, it attempts to publish the active branch. It runs

$ git flow release publish <version>

delete

git easyrelease delete [version]

Extends git flow release delete with extra semver functionality. Without version, it attempts to delete the active branch. It runs

$ git flow release delete <version>

Roadmap

These percentages are pretty arbitrary. Today’s 47% could be tomorrow’s 90% or vice versa.

Main Features

Once all of these are finished, I’ll release v1. Until then, v0 should be used with caution, because it’s not stable.

Progress	Feature
100%	Testing v0.2.0

Eventual Features

These are things I’d like to add, but probably won’t be included in v1. If not, they’ll most likely constitute one or more minor version increments.

Progress	Feature
10%	git config integration (or, rather, gitflow config integration
0%	Disable base without gitflow-avh

Copyright 2018 CJ Harries

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.