AutoGitSemVer 0.7.8

Generate a semantic version based on commits made to a git repository.

AutoGitSemVer

Generate a semantic version based on commits made to a git repository.

Overview

AutoGitSemVer uses commits in a git repository to calculate a semantic version. A commit's title and/or description can be used to increment a specific part of the semantic version and configuration files can be applied to control how the semantic version is generated. Finally, multiple, distinct semantic versions can be generated from different directories within the source tree.

How to use AutoGitSemVer

Running the Executable

From a terminal window, run:

Scenario	Command Line	Output
Standard	autogitsemver	Loading AutoGitSemVer configuration...DONE! (0, 0:00:00.001464, default configuration info will be used) Enumerating changes...DONE! (0, 0:00:00.193258, 1 change processed, no changes applied [0.00%]) Calculating semantic version... 0.6.1+20240318122529.BROWNELL08 DONE! (0, 0:00:00.054236)   Results: DONE! (0, 0:00:00.267488)
Without Metadata	autogitsemver --no-metadata	Loading AutoGitSemVer configuration...DONE! (0, 0:00:00.001468, default configuration info will be used) Enumerating changes...DONE! (0, 0:00:00.201744, 1 change processed, no changes applied [0.00%]) Calculating semantic version... 0.6.1 DONE! (0, 0:00:00.060190)   Results: DONE! (0, 0:00:00.281524)
Quiet	autogitsemver --quiet	0.6.1+20240318122751.BROWNELL08
Verbose	autogitsemver --verbose	Loading AutoGitSemVer configuration...DONE! (0, 0:00:00.001416, default configuration info will be used) Enumerating changes... VERBOSE: Processing '11c41919cb2ed8ef26542665fc9caa6544081457' (2024-03-09 11:53:11-05:00)...DONE! (0, 0:00:00.000049, 0.6.1) DONE! (0, 0:00:00.192439, 1 change processed, no changes applied [0.00%]) Calculating semantic version... 0.6.1+20240318122836.BROWNELL08 DONE! (0, 0:00:00.053696)   Results: DONE! (0, 0:00:00.265691)
Display Help	autogitsemver --help	Usage: autogitsemver [OPTIONS] [PATH]   Automatically generates semantic versions based on changes in a git repository.   ┌─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ │ path [PATH] Generate a semantic version based on changes that impact the specified path. [default: C:\Code\AutoGitSemVer] │ └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ ┌─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ │ --style [Standard|AllPrerelease|AllMetadata] Specifies the way in which the semantic version is generated; this is useful when targets using the generated │ │ semantic version do not fully support the semantic version specification. │ │ [default: GenerateStyle.Standard] │ │ --prerelease-name TEXT Create a semantic version string with this prerelease name. [default: None] │ │ --no-prefix Do not include the prefix in the generated semantic version. │ │ --no-branch-name Do not include the branch name in the prerelease section of the generated semantic version. │ │ --no-metadata Do not include the build metadata section of the generated semantic version. │ │ --verbose Write verbose information to the terminal. │ │ --debug Write debug information to the terminal. │ │ --quiet Do not display any information other than the generated semantic version. │ │ --version Display the version of this tool and exit. │ │ --install-completion [bash|zsh|fish|powershell|pwsh] Install completion for the specified shell. [default: None] │ │ --show-completion [bash|zsh|fish|powershell|pwsh] Show completion for the specified shell, to copy it or customize the installation. [default: None] │ │ --help Show this message and exit. │ └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
Version	autogitsemver --version	autogitsemver v0.7.0

Running with Python

from io import StringIO
from pathlib import Path

from AutoGitSemVer import GetSemanticVersion
from dbrownell_Common.Streams.DoneManager import DoneManager


with DoneManager.Create(StringIO(), "") as dm:
    path = Path.cwd()

    result = GetSemanticVersion(dm, path)

print(result.semantic_version_string)

Updating the Version

A simplified semantic version is defined by a major number, a minor number, and a patch number in the form:

<major>.<minor>.<patch>

Changes to each of these numbers convey different meanings to those who have taken a dependency on the solution decorated by a semantic version:

• Changes to a major number indicate that backwards-incompatible functionality was introduced.
• Changes to a minor number indicate that backwards-compatible functionality was introduced.
• Changes to a patch number indicate that changes were introduced (but those changes did not introduce new functionality).

By default, AutoGitSemVer will increment the patch number for each git commit encountered.

Customizing the Update

The following tokens can be added anywhere in a git commit's title or description to increment the major, minor, or patch numbers:

Semantic Version Number	Git Comment Token(s)	Example
major	+major	1.2.3 -> 2.0.0
minor	+minor, +feature	1.2.3 -> 1.3.0
patch	+patch	1.2.3 -> 1.2.4

Examples

Modifier in the Description

Git Commit Title:	Added feature Foo
Git Commit Description:	Foo lets a user... +minor

Modifier in the Title

Git Commit Title:	Added feature Foo (+minor)
Git Commit Description:	Foo lets a user...

Advanced Configuration

Configuration Files

The way in which semantic versions are generated can be customized through configuration files named:

• AutoGitSemVer.json
• AutoGitSemVer.yaml
• AutoGitSemVer.yml

These configuration files will impact the semantic versions generated for any changes in files or directories in the directory or its children. For example, given the directory structure:

<root>
|- File1.txt
|- DirectoryA
   |- AutoGitSemVer.json
   |- FileA.txt
   |- DirectoryA.1
      |- FileA1.txt
|- DirectoryB
   |- AutoGitSemVer.yaml
   |- FileB.txt

File with Changes	Configuration Filename
File1.txt	None
FileA.txt	DirectoryA/AutoGitSemVer.json
FileA1.txt	DirectoryA/AutoGitSemVer.json
FileB.txt	DirectoryB/AutoGitSemVer.yaml

The configuration file used when generating the semantic version is displayed when running AutoGitSemVer.

Information about the contents of these configuration files can be found in AutoGitSemVerSchema.SimpleSchema.

A simple example of a configuration file can be found here.

Additional Information

Additional information can be found at these locations.

Title	Document	Description
Code of Conduct	CODE_OF_CONDUCT.md	Information about the the norms, rules, and responsibilities we adhere to when participating in this open source community.
Contributing	CONTRIBUTING.md	Information about contributing code changes to this project.
Development	DEVELOPMENT.md	Information about development activities involved in making changes to this project.
Governance	GOVERNANCE.md	Information about how this project is governed.
Maintainers	MAINTAINERS.md	Information about individuals who maintain this project.
Security	SECURITY.md	Information about how to privately report security issues associated with this project.

License

AutoGitSemVer is licensed under the MIT license.