SemanticBumper - A version bumper
SemanticBumper is a version bumping CLI program built using Go. The idea for this project was taken from an OSI issue.
A version bumping program built with Go.
Install
To install SemanticBumper, you must have installed Go. You can install SemanticBumper with the following command:
go get github.com/TheOtterlord/SemanticBumper
Usage
To bump files to a new version, you must create a .bumped
file that follows the schema provided.
Open the command line and navigate to the directory of your project and associated .bumped
file.
Run SemanticBumper myfile.bumped
using your .bumped
file in place of myfile.bumped
.
Example:
SemanticBumper myfile.bumped
Bumped Schema
The .bumped
files follow a simple schema.
At the top, the version
field specifies what the new version is.
version: 0.1.1
After that, a bumps
field can be used to specify all files to be bumped.
bumps:
These files are written on a new line with a -
prefix. The files must be relative to the .bumped
files directory.
bumps:
- README.md
Example:
version: 1.2.3
bumps:
- README.md
- main.example
- lib.example
If you are maintaining an application and library within the smae project and they don't share the same version number, that's ok. SemanticBumper supports multiple version bumping groups.
Example:
version: 1.1.0
bumps:
- README.md
- main.example
version: 1.0.1
- lib.example
TIP: You can also add comments using a //
prefix.
// bump file for my-project
// bump my app
version: 1.1.0
bumps:
- README.md
- main.example
// bump my library
version: 1.0.1
- lib.example