semver-generator/README.md at 1b2292f6cb56beb6d64dc498ad7d6a7f154d05aa

lukaszraczylo/semver-generator

Fork 0

mirror of https://github.com/lukaszraczylo/semver-generator.git synced 2026-06-05 22:49:25 +00:00

Files

T

lukaszraczylo 1b2292f6cb

Add ability to start from user specified hash.

This feature can be useful for repositories with already established versioning, but
having hundreds of commits which could potentially produce really weird results due
to lack of previous rules on wording.

2021-07-27 10:22:02 +01:00

3.5 KiB

Raw Blame History

Semantic version generator

Project created overnight, to prove that management of semantic versioning is NOT painful and do not require arguments and debates within the team. Simple, clean and only thing the project team should need to agree to are the keywords.

Semantic version generator

How does it work

Binary clones the github repository
Iterates through the list of commits looking for the keywords specified in config file for additional bumps of versions
Returns the semantic version which can be included in the release

Usage

As a binary

bash$ ./semver-gen generate -r https://github.com/nextapps-de/winbox
SEMVER 9.0.10
bash$ ./semver-gen generate -l
SEMVER 5.1.1

** Local repository flag -l will always take precedence over remote repository URL **

Usage:
  semver-gen generate [flags]
  semver-gen [command]

Available Commands:
  generate    Generates semantic version
  help        Help about any command

Flags:
  -c, --config string       Path to config file (default "config.yaml")
  -h, --help                help for semver-gen
  -l, --local               Use local repository
  -r, --repository string   Remote repository URL. (default "https://github.com/lukaszraczylo/simple-gql-client")

As a github action

jobs:
  prepare:
    name: Preparing build context
    runs-on: ubuntu-latest
    outputs:
      RELEASE_VERSION: ${{ steps.semver.outputs.semantic_version }}
    steps:
      - name: Checkout repo
        uses: actions/checkout@v2
        with:
          fetch-depth: '0'
      - name: Semver run
        id: semver
        uses: lukaszraczylo/semver-generator@1.0.29
        with:
          config_file: config.yaml
          # either...
          repository_local: true
          # or...
          repository_url: https://github.com/lukaszraczylo/simple-gql-client
      - name: Semver check
        run: |
          echo "Semantic version detected: ${{ steps.semver.outputs.semantic_version }}"

Calculations example

0.0.1 - PATCH - starting commit
0.0.2 - PATCH - another commit
0.0.4 - PATCH - another commit with word 'Update' => DOUBLE increment PATCH
0.1.0 - MINOR - after commit with word 'Change' => increment MINOR, reset PATCH
0.1.1 - PATCH - additional commit
1.0.1 - MAJOR - commit with word 'BREAKING' = > INCREMENT MAJOR, reset MINOR
1.0.2 - PATCH - another commit

Example configuration

version: 1
force:
  major: 1
  minor: 0
  patch: 1
  commit: 69fbe2df696f40281b9104ff073d26186cde1024
wording:
  patch:
    - update
    - initial
  minor:
    - add
    - change
    - improve
  major:
    - breaking
    - the # For testing purposes

version: is not respected at the moment, introduced for potential backwards compatibility in future
force: sets the "starting" version, you don't need to specify this section as the default is always 0
force.commit allows you to set commit hash from which the calculations should start
wording: words the program should look for in the git commits to increment (patch|minor|major)

Good to know

Word matching uses fuzzy search AND is case INSENSITIVE
I do not recommend using common words ( like "the" from the example configuration )

3.5 KiB Raw Blame History