Skip to content

Latest commit

 

History

History
285 lines (204 loc) · 13 KB

README.md

File metadata and controls

285 lines (204 loc) · 13 KB
Raw

Conventional Commits Next Version

crates.io Conventional Commits License

A tooling and language agnostic utility to calculate the next semantic version based on the Conventional Commits since the prior version. Supports monorepos.

Why use Conventional Commits Next Version?

  • Tooling & Language Agnostic - For input command-line arguments are utilised, there is no inbuilt functionality that only parses tooling or language-specific files for input.
  • No Dependencies - A binary download is provided, removing dependencies on downloading tools or interpreted languages.
  • Monorepo Support - Monorepo usage is supported, only commits altering the specified directory are used.
  • Not A Linter - Minor deviations from the Conventional Commits specification are still accepted as valid input, because this is not a linter (but we suggest you use Conventional Commits Linter).
  • Flexible - Non-Conventional Commits are ignored when encountered, and the calculation continues.

Content

Usage

Conventional Commits Next Version can either operate upon a range of Git commits in the repositories' history or on a commit message provided by standard in. To provide a commit message by standard in simple add the flag --from-stdin and standard in will be read. Otherwise to specify the range of commits you can add either the --from-commit-hash <commit-hash> or --from-reference <reference> arguments. The range of commits starts exclusively from the commit specified till inclusively of HEAD.

Any commits which conform to the Conventional Commits v1.0.0 specification are used to calculate the next Semantic Versioning, based upon the initial semantic version provided via the argument --from-version <version>.

The only required arguments is --from-version <version> and any of --from-stdin, --from-commit-hash <commit-hash> or --from-reference <reference> arguments.

The next semantic version can be calculated using a variety of calculation modes. Currently there are two modes, consecutive and batch mode.

Usage - Consecutive Mode

In consecutive mode each Git commit in the Conventional Commits specification is applied to Semantic Versioning calculation in chronological order.

Consecutive mode is the default, so no additional flags or configuration needs supplied.

E.g.

git clone https://github.com/yargs/yargs.git
cd yargs
git checkout 6014e39bca3a1e8445aa0fb2a435f6181e344c45
RUST_LOG=trace conventional_commits_next_version --from-commit-hash c36c571e4e15dfe26be1d919e4991fb6ab6ed9fd --from-version 15.2.0

Using the environment variable RUST_LOG we can enable more detailed logging, so we can see the logic of consecutive mode.

DEBUG conventional_commits_next_version_lib::commits::commit > "fix: address ambiguity between nargs of 1 and requiresArg (#1572)\n\n" matches a patch Semantic Versioning increment commit message.

From the logs we can see that the commit a5edc328ecb3f90d1ba09cfe70a0040f68adf50a has the Conventional Commits type of fix. The fix type will cause the increment of the initial semantic version provided via --from-version from 15.2.0 to 15.2.1.

DEBUG conventional_commits_next_version_lib::commits::commit > "feat(yargs-parser): introduce single-digit boolean aliases (#1576)\n\n" matches a minor Semantic Versioning increment commit message.

From the logs we can see that the commit 3af7f04cdbfcbd4b3f432aca5144d43f21958c39 has the Conventional Commits type of feat. The feat type encountered will increment the minor semantic version from 15.2.1 to 15.3.0.

DEBUG conventional_commits_next_version_lib::commits::commit > "feat: add usage for single-digit boolean aliases (#1580)\n\n" matches a minor Semantic Versioning increment commit message.

From the logs we can see that the commit 6014e39bca3a1e8445aa0fb2a435f6181e344c451 has the Conventional Commits type of feat. The feat type will increment the minor semantic version from 15.3.0 to 15.4.0.

There are no more Conventional Commits which will increment the Semantic Versioning, so the calculated Semantic Versioning is printed to standard out.

15.4.0

Usage - Batch Mode

In batch mode the largest Semantic Versioning increment determined by the Conventional Commits type across all the commits is the only increment applied.

Batch mode can be selected via the --calculation-mode "Batch" argument.

E.g.

git clone https://github.com/yargs/yargs.git
cd yargs
git checkout 6014e39bca3a1e8445aa0fb2a435f6181e344c45
RUST_LOG=trace conventional_commits_next_version --calculation-mode "Batch" --from-commit-hash c36c571e4e15dfe26be1d919e4991fb6ab6ed9fd --from-version 15.2.0

Using the environment variable RUST_LOG we can see more detailed logs, to see how batch mode behaves differently.

DEBUG conventional_commits_next_version_lib::commits::commit > "feat(yargs-parser): introduce single-digit boolean aliases (#1576)\n\n" matches a minor Semantic Versioning increment commit message.
DEBUG conventional_commits_next_version_lib::commits::commit > "feat: add usage for single-digit boolean aliases (#1580)\n\n" matches a minor Semantic Versioning increment commit message.

The largest increment is a minor Semantic Versioning increment, because of the two commits 3af7f04cdbfcbd4b3f432aca5144d43f21958c39 and 6014e39bca3a1e8445aa0fb2a435f6181e344c45 with feat as the Conventional Commits' type. The minor Semantic Versioning increment increases the initial semantic version from 15.2.0 to 15.3.0, which is then printed to standard out.

15.3.0

Usage - Git Environment Variables

When looking for a repository the Git environment variables are respected. When ${GIT_DIR} is set, it takes precedence and Conventional Commits Next Version begins searching for a repository in the directory specified in ${GIT_DIR}. When ${GIT_DIR} is not set, Conventional Commits Next Version searches for a repository beginning in the current directory.

Usage - Logging

The crates pretty_env_logger and log are used to provide logging. The environment variable RUST_LOG can be used to set the logging level. See https://crates.io/crates/pretty_env_logger for more detailed documentation.

CICD Examples

GitLab CI Rust Project Example

Via Cargo

See Compiling via Cargo for more details about installing via Cargo.

Note - This example downloads the latest 6.* version.

conventional-commits-next-version-checking:
    stage: conventional-commits-next-version-checking
    image: rust
    before_script:
        - cargo install conventional_commits_next_version --version ^6
    script:
        # Get current version.
        - current_version=$(grep "^version = \"[0-9][0-9]*.[0-9][0-9]*.[0-9][0-9]*\"$" "Cargo.toml" | cut -d '"' -f 2)
        # Get latest tag.
        - latest_tag=$(git describe --tags --abbrev=0)
        # Check current vs expected.
        - /usr/local/cargo/bin/conventional_commits_next_version --calculation-mode "Batch" --from-reference "${latest_tag}" --from-version "${latest_tag}" --current-version "${current_version}"
    rules:
        - if: $CI_MERGE_REQUEST_ID

Via Binary Download

See Downloading Binary for more details about Binary downloads.

Note - This example downloads version 6.0.0.

conventional-commits-next-version-checking:
    stage: conventional-commits-next-version-checking
    image: rust
    before_script:
        - wget -q -O tmp.zip "https://gitlab.com/DeveloperC/conventional_commits_next_version/-/jobs/artifacts/bin-6.0.0/download?job=release-binary-compiling-x86_64-linux-musl" && unzip tmp.zip && rm tmp.zip
    script:
        # Get current version.
        - current_version=$(grep "^version = \"[0-9][0-9]*.[0-9][0-9]*.[0-9][0-9]*\"$" "Cargo.toml" | cut -d '"' -f 2)
        # Get latest tag.
        - latest_tag=$(git describe --tags --abbrev=0)
        # Check current vs expected.
        - ./conventional_commits_next_version --calculation-mode "Batch" --from-reference "${latest_tag}" --from-version "${latest_tag}" --current-version "${current_version}"
    rules:
        - if: $CI_MERGE_REQUEST_ID

Git Hooks Rust Project Example

An example commit-msg Git hook to check if a Rust projects semantic version needs increased because of the commit message.

#!/usr/bin/env bash

set -o errexit
set -o pipefail

commit_message=$(cat "${1}")

# Get current version in the commit to be made.
current_version=$(grep "^version = \"[0-9][0-9]*.[0-9][0-9]*.[0-9][0-9]*\"$" "Cargo.toml" | cut -d '"' -f 2)
# Get latest version on the remote HEAD.
head_version=$(git show remotes/origin/HEAD:Cargo.toml | grep "^version = \"[0-9][0-9]*.[0-9][0-9]*.[0-9][0-9]*\"$" "Cargo.toml" | cut -d '"' -f 2)

# Check current commits version vs expected because of the new commit's message.
echo "${commit_message}" | "${HOME}/.cargo/bin/conventional_commits_next_version" --from-stdin --from-version "${head_version}" --current-version "${current_version}"

Downloading Binary

Statically linked compiled binaries are available for download. Visit the releases page at https://github.com/DeveloperC286/conventional_commits_next_version/releases to see all the releases, the release notes contains links to binary downloads for various architectures.

If you do not trust the provided binaries another option is to compile your own and then make it available for remote download, so your CICD etc can then download it.

Compiling via Local Repository

Checkout the code repository locally, change into the repository's directory and then build via Cargo. Using the --release flag produces an optimised binary but takes longer to compile.

git clone [email protected]:DeveloperC286/conventional_commits_next_version.git
cd conventional_commits_next_version/
cargo build --release

The compiled binary is present in target/release/conventional_commits_next_version.

Compiling via Cargo

Cargo is the Rust package manager, the install sub-command pulls from crates.io and then compiles the binary locally, placing the compiled binary at ${HOME}/.cargo/bin/conventional_commits_next_version.

cargo install conventional_commits_next_version

By default it installs the latest version at the time of execution. You can specify a specific version to install using the --version argument. For certain environments such as CICD etc you may want to pin the version.

E.g.

cargo install conventional_commits_next_version --version 6.0.0

Rather than pinning to a specific version you can specify the major or minor version.

E.g.

cargo install conventional_commits_next_version --version ^6

Will download the latest 6.* release whether that is 6.0.2 or 6.2.0.

Unit Testing

The unit test suite has several parameterised tests testing the Conventional Commits v1.0.0 format parsing. Cargo is used to set up and run all the unit tests.

cargo test

End-to-End Testing

To ensure correctness as there are various out of process dependencies, the project has an End-to-End behaviour driven test suite using the Behave framework (https://github.com/behave/behave).

To run the test suite you need to

  • Compile the Convention Commits Next Version binary.
  • Install Python3.
  • Install Behave.
  • Execute Behave.

Note - You can't use --release as the test suite uses target/debug/conventional_commits_next_version.

cargo build
cd conventional_commits_next_version/end-to-end-tests/
virtualenv -p python3 .venv
source .venv/bin/activate
pip3 install -r requirements.txt
behave

Issues/Feature Requests

To report an issue or request a new feature use https://github.com/DeveloperC286/conventional_commits_next_version/issues.