A git plugin to make adherance to

• Semantic Versioning 2.0.0
• Change Log Management (optional)

easier.

With its default settings, git semver requires a CHANGELOG.md file to be maintained. This will be need be filled for the version before the version is created.

Change log management can be disabled however this is NOT recommended.

Semantic Versioning 2.0.0 is a scheme for versioning, which includes 3 parts e.g. 3.2.1 the components of which are:

• Major: Used only for backward compatible breaking changes, i.e. when we have an all new theme etc.
• Minor: Used for normal development, i.e. creating a new template
• Bug fixes

A change log is a file which contains a curated, chronologically ordered list of notable changes for each version of a project.

git-semver uses change log convention from Keep a CHANGELOG. A change log lists notable changes for each release of a project.

For a new version to be generated, a change log must have already been commited which includes:

• Details of the version (including version number and, date)
• A list of changes under one or more of the headings:
  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for once-stable features removed in upcoming releases.
  • Removed for deprecated features removed in this release.
  • Fixed for any bug fixes.
  • Security to invite users to upgrade in case of vulnerabilities.
• An updated unreleased link at the bottom of the file
• A version link at the bottom of the file

## [{{version}}] - {{YYYY-MM-DD}}

### Added
- Details...

...

[unreleased]: https://github.com/oban/oban-site/compare/{{version}}...HEAD
[{{version}}]: https://github.com/oban/oban-site/compare/{{previous version}}...{{version}}

See Keep a CHANGELOG for full details.

Change log checking can be disabled by changing the configuration setting:

CHANGELOG_CHECK=0

Via git clone.

The installer installs git-semver into the first of the following directories that exist and are in the path:

• /usr/local/bin
• /usr/bin
• /bin

In Linux, OSX and Windows Cygwin the installer will create a symlink. In Windows MinGW creates a stub instead.

git clone [email protected]/markchalloner/git-semver.git
sudo git-semver/install.sh

The installer will not overwrite any existing configuration.

git semver get

Will return empty if no version has been created.

Versions are created as tags and are generated using:

git semver [major|minor|patch|next]

Increment the patch component (0.1.0 -> 0.1.1)

git semver patch|next

If no version has been created, the initial version will be: 0.1.0

Increment the minor component (0.1.0 -> 0.2.0)

git semver minor

If no version has been created, the initial version will be: 0.1.0

Increment the major component (0.1.0 -> 1.0.0)

git semver major

If no version has been created, the initial version will be: 1.0.0

See [Updates]

git semver update

Run git semver with no arguments to see usage

git semver [help]

Configuration is stored in the file ${HOME}/.git-semver/config. An example configuration file with the default settings can be found at config.example.

The tool has a built in updater that checks for a new version of git semver

git semver update

By default it will automatically check for a new version daily. The automatic check can be disabled by changing the configuration setting:

UPDATE_CHECK=0

The updaate check interval in days can be set by changing the configuration setting:

UPDATE_CHECK_INTERVAL_DAYS=1

The date of the last check is saved in ${HOME}/.git-semver/update

Via uninstaller in clone directory. Navigate to your original clone directory and run:

sudo git-semver/uninstall.sh [-p|--purge]

The purge switch will additionally remove the configuration directory.

git-semver is installed by placing a symlink/stub in one of the bin directories in the path.

• ${HOME}/bin
• /usr/local/bin
• /usr/bin
• /bin

It can be deleted easily:

sudo rm $(which git-semver)

The configuration directory can be removed with:

rm -rf ${HOME}/.git-semver

Please see CHANGELOG.md for more information what has changed recently.

Please see CONTRIBUTING.md for details.