Skip to content

Latest commit

 

History

History
41 lines (36 loc) · 3.36 KB

configuration.md

File metadata and controls

41 lines (36 loc) · 3.36 KB

Configuration

You can configure commisery-action using a YAML-based configuration file:

max-subject-length: 120
tags:
  docs: Documentation changes not part of the API
  example:
    description: Changes to example code in the repository
  perf:
    description: Performance improvements
    bump: true

disable:
  - C001
  - C018
enable:
  - C026
allowed-branches: "^ma(in|ster)$"
initial-development: false  # OPTIONAL, defaults to `true`
Item Default value Description
max-subject-length 80 The maximum length of the subject of the commit message
tags fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test, improvement Specify a custom list of Conventional Commit types to allow. If provided, this will overwrite the default list, so be sure to include those if you want to retain them.
tags takes a dict per type tag, with two values that can be set:
  • description: a human-readable description of what the type should be used for.
  • bump: if set to true, will cause commits with this type to also bump the PATCH version component, same as fix.
If you only specify YAML string, it shall be treated as the description; the bump will be false implicitly.

NOTE: The type tags feat and fix will automatically be provided

ALSO NOTE: bump is set to true for the revert type by default
disable None List of rules to disable as part of the checker
enable None List of rules to enable as part of the checker (some rules are disabled by default)
allowed-branches .* A regex specifying from which branch(es) releases and Git tags are allowed to be created
initial-development true A boolean indicating that this project is still under initial development. During this state, any commit message containing a breaking change will result in a MINOR version bump.
version-prefix "*" An optional prefix specifying the tags to consider. "*" is a special value, meaning the closest version is used, regardless of prefix
version-scheme semver The versioning scheme to use. Supported values: semver, sdkver.
release-branches /^release\/.*\d+\.\d+\.*$/ A regex specifying from which branch(es) only PATCH version bump are allowed.
release-discussion-category undefined A string specifying an existing GitHub discussion category name. This requires GitHub discussions to be enabled on the repository.
prereleases undefined A string specifying the prereleases prefix.
sdkver-create-release-branches false For SdkVer versioning scheme only: push a new branch if an RC or release build is performed on a non-release branch. If this config value is boolean true, the branch shall be of the form release/N.N. If this value is set to a string, it shall be used as the branch name prefix and appended with the major and minor release numbers, e.g. config value "rel/" results in a branch named rel/N.N.
sdkver-max-major 0 For SdkVer versioning scheme only: do not bump major version when breaking changes are found in case the maximum configured major version is already reached.

💡 By default commisery-action will search for the file .commisery.yml. You can specify a different file with the config input parameter.