Skip to main content

Simple

This preset can be used by setting the preset global configuration option value to simple and brings standard configurations well suited to get started with common items, as follows.

Commit message conventions

The Conventional Commits convention comes with this preset. This corresponds to the following configuration options:

NameValue
commitMessageConventions/enabled["conventionalCommits"]
commitMessageConventions/conventionalCommits/expression"(?m)^(?<type>[a-zA-Z0-9_]+)(\((?<scope>[a-zA-Z0-9 \-_]+)\))?(!)?:( (?<title>.+))$(?s).*"
commitMessageConventions/conventionalCommits/bumpExpressions"major" = "(?s)(?m)^[a-zA-Z0-9_]+(\([a-zA-Z0-9 \-_]+\))?(!: .*|.*^(BREAKING( |-)CHANGE: )).*", "minor" = "(?s)(?m)^feat(!{0})(\([a-zA-Z0-9 \-_]+\))?: (?!.*^(BREAKING( |-)CHANGE: )).*", "patch" = "(?s)(?m)^fix(!{0})(\([a-zA-Z0-9 \-_]+\))?: (?!.*^(BREAKING( |-)CHANGE: )).*"

Release types

This preset comes with a few release types, suitable for a mainline only branching model. An additional release type called internal is configured as a fallback when the mainline isn't matched.

info

Please note that even if a release type has its publish flag enabled, publication to remote services doesn't happen because no service is configured and none is listed in the publicationServices list. If you want to publish releases using this preset as a starting point you need to configure some services and override the releaseTypes/publicationServices.

This corresponds to the following configuration options:

NameValue
releaseTypes/enabled["mainline", "internal"]
releaseTypes/publicationServicesEmpty
releaseTypes/mainline/collapseVersionsfalse
releaseTypes/mainline/collapsedVersionQualifierEmpty
releaseTypes/mainline/descriptionEmpty
releaseTypes/mainline/filterTags"^({{configuration.releasePrefix}})?([0-9]\d*)\.([0-9]\d*)\.([0-9]\d*)$"
releaseTypes/mainline/gitCommit"false"
releaseTypes/mainline/gitCommitMessageEmpty (use default)
releaseTypes/mainline/gitPush"true"
releaseTypes/mainline/gitTag"true"
releaseTypes/mainline/gitTagMessageEmpty (use default)
releaseTypes/mainline/identifiersEmpty
releaseTypes/mainline/matchBranches"^(master|main)$"
releaseTypes/mainline/matchEnvironmentVariablesEmpty
releaseTypes/mainline/matchWorkspaceStatus"CLEAN"
releaseTypes/mainline/publish"true"
releaseTypes/mainline/versionRangeEmpty
releaseTypes/mainline/versionRangeFromBranchNamefalse
releaseTypes/internal/collapseVersionstrue
releaseTypes/internal/collapsedVersionQualifier"internal"
releaseTypes/internal/descriptionEmpty
releaseTypes/internal/filterTagsEmpty
releaseTypes/internal/gitCommit"false"
releaseTypes/internal/gitCommitMessageEmpty (use default)
releaseTypes/internal/gitPush"false"
releaseTypes/internal/gitTag"false"
releaseTypes/internal/gitTagMessageEmpty (use default)
releaseTypes/internal/identifiers/0/position"BUILD"
releaseTypes/internal/identifiers/0/qualifier"timestamp"
releaseTypes/internal/identifiers/0/value"{{#timestampYYYYMMDDHHMMSS}}{{timestamp}}{{/timestampYYYYMMDDHHMMSS}}"
releaseTypes/internal/matchBranchesEmpty
releaseTypes/internal/matchEnvironmentVariablesEmpty
releaseTypes/internal/matchWorkspaceStatusEmpty
releaseTypes/internal/publish"false"
releaseTypes/internal/versionRangeEmpty
releaseTypes/internal/versionRangeFromBranchNamefalse