feat: change minor pattern to support optional conventional commit scopes

The Conventional Commits spec allows optional scopes to be present after the change type, e.g. `feat(scope):`. The current minor pattern will only bump the minor version number if the pattern exactly matches `feat:`. This change is backwards compatible and adds support for these scopes.
This commit is contained in:
Dom Light 2026-01-23 09:21:26 +00:00 committed by GitHub
parent 7bf8143b3b
commit 67c95513f8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 21 additions and 7 deletions

View file

@ -31,7 +31,7 @@ inputs:
minor_pattern:
description: "A string which, if present in a git commit, indicates that a change represents a minor (feature) change. Wrap with '/' to match using a regular expression."
required: true
default: "/feat:/"
default: "/^feat(\\(.+\\))?:/"
minor_regexp_flags:
description: "A string which indicates the flags used by the `minor_pattern` regular expression. Supported flags: idgs"
required: false

View file

@ -100,7 +100,7 @@ If your project contains multiple services which you wish to version independent
| Value | Description |
| --- | --- |
| `tag_prefix` | The prefix to use for the tag. Defaults to `v`, generally you will use either `v` or an empty string. Note that the tag format is distinct from the version. Tags used for versioning must always follow the pattern `{tag_prefix}{major}.{minor}.{patch}` with and optional `-{namespace}` suffix. |
| `major_pattern` and `minor_pattern` | These strings are used to determine the type of version to create. If any commit message since matches the `major_pattern` the major version will be incremented, if it matches the `minor_pattern` the minor version will be incremented. If neither pattern matches, the patch version will be incremented. These can be specified either as strings or as regular expression by wrapping the expression in `/`. The defaults follow [Conventional Commits](https://www.conventionalcommits.org/): `/!:|BREAKING CHANGE:/` for major and `/feat:/` for minor. |
| `major_pattern` and `minor_pattern` | These strings are used to determine the type of version to create. If any commit message since matches the `major_pattern` the major version will be incremented, if it matches the `minor_pattern` the minor version will be incremented. If neither pattern matches, the patch version will be incremented. These can be specified either as strings or as regular expression by wrapping the expression in `/`. The defaults follow [Conventional Commits](https://www.conventionalcommits.org/): `/!:|BREAKING CHANGE:/` for major and `/feat/(\(.+\))?:/` for minor. |
| `version_format` | A value such as `${major}.${minor}.${patch}-prerelease${increment}` that will be used to format the version value of the output, **formatting this value is the only effect of this input parameter!** It is not used for parsing or any other purpose. It is a convenient alternative to formatting the output in a subsequent step. |
| `user_format_type` | Indicates the format of the `authors` output. Can be `json` or `yaml`. |
| `enable_prerelease_mode` | If true, major changes to versions starting with 0 will result in a minor change, preventing ths initial version `1.0.0`` from being created automatically by someone checking in a commit with the major pattern. |

View file

@ -14,8 +14,8 @@ release. To accomplish this, the next version number is calculated along with
a commit increment indicating the number of commits for this version. The
commit messages are inspected to determine the type of version change the next
version represents. By default, this action follows [Conventional Commits](https://www.conventionalcommits.org/)
patterns: commits with `feat:` trigger minor version bumps, and commits with a `!` suffix
(e.g., `feat!:`, `fix!:`) or containing `BREAKING CHANGE:` trigger major version bumps.
patterns: commits with `feat:` or `feat(scope):` trigger minor version bumps, and commits with a `!` suffix
(e.g., `feat!:`, `fix!:`, `refactor(scope)!:`) or containing `BREAKING CHANGE:` trigger major version bumps.
# Background
@ -85,7 +85,7 @@ it will be given the new version if the build were to be retriggered, for exampl
# A string which indicates the flags used by the `major_pattern` regular expression. Supported flags: idgs
major_regexp_flags: ""
# Same as above except indicating a minor change, supports regular expressions wrapped with '/'
minor_pattern: "/feat:/"
minor_pattern: "/^feat(\\(.+\\))?:/"
# A string which indicates the flags used by the `minor_pattern` regular expression. Supported flags: idgs
minor_regexp_flags: ""
# A string to determine the format of the version output

View file

@ -13,7 +13,7 @@ export class ActionConfig {
/** A string which indicates the flags used by the `majorPattern` regular expression. */
public majorFlags: string = "";
/** A string which, if present in a git commit, indicates that a change represents a minor (feature) change. Wrap with '/' to match using a regular expression. */
public minorPattern: string = "/feat:/";
public minorPattern: string = "/^feat(\(.+\))?:/";
/** A string which indicates the flags used by the `minorPattern` regular expression. */
public minorFlags: string = "";
/** Pattern to use when formatting output version */

View file

@ -33,7 +33,7 @@ program
.option(
"-m, --minor-pattern <pattern>",
"Regex pattern for minor version bumps",
"/feat:/",
"/^feat(\(.+\))?:/",
)
.option("--minor-flags <flags>", "Flags for minor pattern regex", "")
.option(

View file

@ -217,6 +217,20 @@ testInterfaces.forEach((testInterface) => {
timeout,
);
test(
"Minor commits with conventional commit scopes bump minor version",
async () => {
const repo = createTestRepo(testRunner); // 0.0.0+0
repo.makeCommit("Initial Commit"); // 0.0.1+0
repo.makeCommit("feat(scope): Second Commit"); // 0.1.0+0
const result = await repo.runAction();
expect(result.formattedVersion).toBe("0.1.0+0");
},
timeout,
);
test(
"Tags start new version",
async () => {