0.1.3 • Published 4 years ago

bump-version-cli v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago
█▄▄ █░█ █▀▄▀█ █▀█ ▄▄ █░█ █▀▀ █▀█ █▀ █ █▀█ █▄░█
█▄█ █▄█ █░▀░█ █▀▀ ░░ ▀▄▀ ██▄ █▀▄ ▄█ █ █▄█ █░▀█

Description:

This script automates bumping the git software project's version using automation. It's written in 100% pure bash and npm, the NodeJS task runner.

It does several things that are typically required for releasing a Git repository, like git tagging, automatic updating of CHANGELOG.md, and incrementing the version number in various JSON files. It:

  • Increments / suggests the current software project's version number
  • Adds a Git tag, named after the chosen version number
  • Updates CHANGELOG.md
  • Updates VERSION file
  • Creates a release branch (disable with -v) + switches to it (following the Git branch-based workflow)
  • Commits files to release branch
  • Pushes to a remote (optionally)
  • Updates "version" : "x.x.x" tag in JSON files if -v file1 -v file2... argument is supplied.

Installation

Simply clone the repo and copy bump-version.sh to your project's root.

You may need to set execute permissions for the script, eg $ chmod 755 bump-version.sh

Usage

$ ./bump-version.sh [-v <version no>] [-m <release message>] [-j <file1>] [-j <file2>].. [-n] [-p] [-b] [-h]

Options:

-v <version number>     Specify a manual version number
-m <release message>    Custom release message
-f <filename.json>      Update version number inside JSON files.
                            * For multiple files, add a separate -f option for each one,
                            * For example: ./bump-version.sh -f src/plugin/package.json -f composer.json
-p <repository alias>   Push commits to remote repository, eg `-p Origin`
-n                      Turns off automatic commit
                            * You may want to do that yourself, for example.
-b                      Don't create automatic `release-<version>` branch
-h 	                    Show help message.

Credits

https://github.com/jv-k/bump-version.sh

Inspired by the scripts from @pete-otaqu and @mareksuscak.

License

Released under the MIT license.