Merge pull request #178 from PaulHatch/conventional-commits

feat!: Change default version patterns to follow Conventional Commits

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
         os: [ubuntu-latest, windows-latest]
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: NPM Install
@@ -27,3 +27,9 @@ jobs:
       - name: Run Action
         uses: ./
         id: run
+        with:
+          debug: true
+      - name: Print Diagnostic Output
+        run: echo $DEBUG_OUTPUT
+        env:
+          DEBUG_OUTPUT: ${{ steps.run.outputs.debug_output }}

CHANGELOG.md

@@ -0,0 +1,281 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [5.4.0] - 2024-01-31
+
+### Changed
+- Updated to Node.js v20 runtime
+- Updated all dependencies to latest versions
+
+## [5.3.0] - 2023-09-30
+
+### Added
+- **Branch-based versioning mode** (`version_from_branch` input) - Major/minor versions can now be derived from branch names (e.g., `release/v1`, `release/1.2`). Only considers tags matching the branch version, useful for maintaining multiple release lines
+- Enhanced diagnostics documentation in contributing guide
+- Improved warning messages to clarify when no tags are found vs when tags exist but don't match criteria
+
+### Fixed
+- `GITHUB_REF_NAME` environment variable no longer causes failures during testing
+- `bump_each_commit` now properly respects `enable_prerelease_mode` setting
+- Non-version branches are properly ignored when using branch-based versioning
+
+### Changed
+- Updated Jest configuration for better test isolation
+- Rebuilt distribution files with latest changes
+
+### Deprecated
+- `use_branches` input is deprecated and will be removed in v6.0.0 - use `version_from_branch` instead
+
+## [5.2.1] - 2023-08-24
+
+### Fixed
+- Diagnostic mode output was not being properly included in the action's output, preventing debugging
+
+## [5.2.0] - 2023-08-20
+
+### Added
+- **Debug/diagnostic mode** (`debug` input) - Captures and outputs diagnostic information for troubleshooting version calculations. Useful when the source repository isn't available for direct inspection
+
+## [5.1.0] - 2023-08-09
+
+### Added
+- **Patch pattern filtering** (`bump_each_commit_patch_pattern` input) - When using `bump_each_commit`, patch version only increments if commit matches specified pattern. Supports JavaScript regex syntax with flags (e.g., `/fix\(.*\)/i`)
+- **Pre-release mode** (`enable_prerelease_mode` input) - Prevents automatic major version bumps for 0.x.x versions. When enabled, "major" changes become "minor" and "minor" become "patch", preventing premature 1.0.0 releases
+- `is_tagged` output - Boolean indicating if the current commit already has a version tag
+- Previous version commit information outputs (`previous_commit`, `previous_version`) for better version tracking
+
+### Fixed
+- Corrected tag ordering when determining previous version (was using reverse order incorrectly)
+- Increased test timeout for Windows environments to prevent CI failures
+- Fixed test failures in environments with global GPG signing enabled
+- Documentation typo: "version" output name was incorrectly documented
+
+## [5.0.3] - 2023-01-10
+
+### Fixed
+- Pre-release tags on current commit were not being handled correctly when determining version increments
+- Fixed incorrect parameter name mapping that was causing action failures
+
+### Changed
+- Updated dependencies to latest versions
+
+## [5.0.2] - 2022-12-31
+
+### Fixed
+- Build output mapping was incorrect, causing the action to fail when generating outputs
+
+## [5.0.1] - 2022-12-27
+
+### Fixed
+- Tag prefix and namespace values are now properly escaped when constructing regex patterns, preventing regex errors with special characters
+- Fixed unescaped dots in regex patterns that could cause incorrect matching
+- Test suite now consistently uses 'master' as branch name to avoid CI failures
+
+### Added
+- Syntax highlighting for code examples in documentation
+- Contributing.md guide for developers
+- Test coverage for namespaces containing forward slashes
+
+### Changed
+- Documentation updated to reflect correct input parameter names
+- Version calculation no longer limits the number of tags retrieved, ensuring accurate version determination in repos with many tags
+
+## [5.0.0] - 2022-12-20 - Major Rewrite
+
+### Added
+- **Complete TypeScript rewrite** - Action rewritten from JavaScript to TypeScript with modular architecture
+- **Author tracking** - New `authors` output lists all commit authors since last release, formatted as CSV (JSON option available via `user_format_type`)
+- **Commit body searching** - `search_commit_body` input allows searching commit message bodies for version patterns, not just the subject line
+- **Branch support** - Can now use branch names instead of tags for versioning with `use_branches` input
+- **Improved outputs** - Additional metadata including `version_type`, commit hashes, and more detailed version information
+- **Namespace support without tags** - Namespaces now work even when no existing tags match the namespace
+
+### Fixed
+- Pre-release tags (alpha, beta, rc) are now properly excluded from version calculations unless explicitly included
+- Fixed issue where current commit's tag wasn't properly considered when calculating previous version
+- Tag ordering now uses git's version sort instead of author date, providing more accurate version ordering
+
+### Changed
+- Architecture completely redesigned with providers, resolvers, classifiers, and formatters for better extensibility
+- Short tag support has been completely removed (was deprecated in v4)
+- Updated to actions/core@1.10.0 and modernized all dependencies
+- Node.js 16 compatibility
+
+## [4.0.3] - 2021-10-29
+
+### Changed
+- Version output now properly uses the user-supplied version format template combined with namespace
+- Updated dependencies and improved test coverage
+- Documentation clarifications for better user understanding
+
+## [4.0.2] - 2021-04-22
+
+### Fixed
+- Tag prefixes can now contain forward slashes (e.g., `releases/v`), enabling more flexible tagging schemes
+
+## [4.0.1] - 2021-02-25
+
+### Fixed
+- Fixed regex pattern for matching full version tags when `short_tags` is disabled
+
+## [4.0.0] - 2021-02-08
+
+### Changed
+- **Breaking**: Branch parameter now defaults to `HEAD` instead of requiring explicit branch name
+- Branch names no longer include `origin/` prefix, simplifying branch-based versioning
+- Reintroduced support for using `HEAD` as branch parameter (was removed in v3)
+
+### Deprecated
+- `branch` input is now deprecated in favor of automatic HEAD detection
+
+## [3.3.1] - 2021-01-28
+
+### Added
+- `version_tag` output now includes namespace value, making it easier to identify versioned releases in multi-project repositories
+
+### Changed
+- Improved documentation clarity for namespace feature
+- Enhanced readme formatting and examples
+
+## [3.3.0] - 2021-01-23
+
+### Added
+- **Regular expression support** for `major_pattern` and `minor_pattern` - Wrap patterns in `/` to use regex (e.g., `/breaking:\s/i`)
+
+### Fixed
+- Fixed logic that prevented version tags from being properly matched when calculating increments
+
+## [3.2.1] - 2021-01-16
+
+### Fixed
+- Tagged commits now properly preserve their increment value instead of resetting to 0
+- SVG diagrams now have proper background color for better visibility
+
+### Changed
+- Updated dependencies
+- Documentation improvements
+
+## [3.2.0] - 2020-12-20
+
+### Added
+- **`bump_each_commit` mode** - Every commit creates a new patch version, useful for continuous deployment scenarios
+- **`short_tags` toggle** - When set to `false`, only full semantic version tags (e.g., v1.2.3) are considered, ignoring short tags (e.g., v1)
+
+### Changed
+- Improved documentation with visual diagrams
+- Removed deprecated parameters from documentation
+- Enhanced readme clarity with better examples
+
+## [3.1.2] - 2020-10-07
+
+### Fixed
+- **Full Windows support** - Fixed line ending issues and command execution on Windows
+- Action now properly exits when current commit already has a version tag
+- Current commit's tag is now used as the version when applicable
+
+### Added
+- Complete Windows support in test suite with OS-specific temp directories
+- Windows runner added to CI pipeline alongside Linux
+
+### Changed
+- Commands now run silently to reduce log noise
+- Improved error handling for command execution failures
+- Added warning about actions/checkout@v2 shallow clone behavior that can affect version detection
+
+## [3.1.1] - 2020-09-05
+
+### Fixed
+- Change detection now works correctly when no previous tags exist in the repository
+
+## [3.1.0] - 2020-09-05
+
+### Added
+- **`version_tag` output** - Returns the complete version tag including prefix and namespace
+
+### Changed
+- Improved logging for change detection to help with debugging
+- Command execution failures are now logged as info rather than errors (they're handled gracefully)
+- Updated package dependencies
+
+## [3.0.0] - 2020-09-02 - Multi-Project Support
+
+### Added
+- **Namespace support** (`namespace` input) - Enables multiple projects/components in same repo with isolated versioning
+- **Improved mono-repo support** - Each namespace maintains its own version sequence
+
+### Changed
+- **Breaking**: `change_path` input now filters which paths trigger version changes rather than just detecting changes
+- Removed verbose action output for cleaner logs
+- Modernized codebase and dependencies for GitHub Actions runner compatibility
+
+### Removed
+- Deprecated action inputs from v2
+
+## [2.1.1] - 2020-02-07
+
+### Fixed
+- Release link generation now uses correct branch name format
+
+## [2.1.0] - 2020-01-25
+
+### Added
+- **Path-based change detection** (`change_path` input) - Specify paths to monitor for changes, useful for mono-repos where not all changes should trigger version bumps
+
+### Changed
+- Release link now uses branch name from action input rather than GitHub environment variable
+- Release link is now output to action logs for visibility
+
+## [2.0.0] - 2019-12-24
+
+### Changed
+- **Breaking**: Now uses `git describe` for more reliable tag detection instead of `git log`
+- Added warning when repository has no tags, helping users understand why versioning starts at 0.0.0
+
+## [1.0.1] - 2019-12-11
+
+### Fixed
+- Empty tag prefixes are now supported (useful for repos that use plain version numbers without 'v' prefix)
+
+### Added
+- Documentation for `version_format` input parameter
+
+## [1.0.0] - 2019-12-11 - Initial Release
+
+### Added
+- Automatic semantic versioning based on git commit history
+- Version bumping through commit message markers: `(MAJOR)` and `(MINOR)`
+- Customizable version output format via `version_format` input
+- Support for both short (v1) and full (v1.0.0) version tags
+- Increment counter for commits since last version tag
+- No manual version maintenance required - fully automated from git history
+
+[5.4.0]: https://github.com/PaulHatch/semantic-version/compare/v5.3.0...v5.4.0
+[5.3.0]: https://github.com/PaulHatch/semantic-version/compare/v5.2.1...v5.3.0
+[5.2.1]: https://github.com/PaulHatch/semantic-version/compare/v5.2.0...v5.2.1
+[5.2.0]: https://github.com/PaulHatch/semantic-version/compare/v5.1.0...v5.2.0
+[5.1.0]: https://github.com/PaulHatch/semantic-version/compare/v5.0.3...v5.1.0
+[5.0.3]: https://github.com/PaulHatch/semantic-version/compare/v5.0.2...v5.0.3
+[5.0.2]: https://github.com/PaulHatch/semantic-version/compare/v5.0.1...v5.0.2
+[5.0.1]: https://github.com/PaulHatch/semantic-version/compare/v5.0.0...v5.0.1
+[5.0.0]: https://github.com/PaulHatch/semantic-version/compare/v4.0.3...v5.0.0
+[4.0.3]: https://github.com/PaulHatch/semantic-version/compare/v4.0.2...v4.0.3
+[4.0.2]: https://github.com/PaulHatch/semantic-version/compare/v4.0.1...v4.0.2
+[4.0.1]: https://github.com/PaulHatch/semantic-version/compare/v4...v4.0.1
+[4.0.0]: https://github.com/PaulHatch/semantic-version/compare/v3.3.1...v4
+[3.3.1]: https://github.com/PaulHatch/semantic-version/compare/v3.3...v3.3.1
+[3.3.0]: https://github.com/PaulHatch/semantic-version/compare/v3.2.1...v3.3
+[3.2.1]: https://github.com/PaulHatch/semantic-version/compare/v3.2...v3.2.1
+[3.2.0]: https://github.com/PaulHatch/semantic-version/compare/v3.1.2...v3.2
+[3.1.2]: https://github.com/PaulHatch/semantic-version/compare/v3.1.1...v3.1.2
+[3.1.1]: https://github.com/PaulHatch/semantic-version/compare/v3.1...v3.1.1
+[3.1.0]: https://github.com/PaulHatch/semantic-version/compare/v3...v3.1
+[3.0.0]: https://github.com/PaulHatch/semantic-version/compare/v2.1.1...v3
+[2.1.1]: https://github.com/PaulHatch/semantic-version/compare/v2.1...v2.1.1
+[2.1.0]: https://github.com/PaulHatch/semantic-version/compare/v2...v2.1
+[2.0.0]: https://github.com/PaulHatch/semantic-version/compare/v1.0.1...v2
+[1.0.1]: https://github.com/PaulHatch/semantic-version/compare/v1...v1.0.1
+[1.0.0]: https://github.com/PaulHatch/semantic-version/releases/tag/v1

action.yml

@@ -12,14 +12,30 @@ inputs:
     description: "The prefix to use to identify tags"
     required: false
     default: "v"
+  use_branches:
+    description: "(Deprecated) Use branches instead of tags"
+    required: false
+    default: "false"
+  version_from_branch:
+    description: If true, the branch will be used to select the maximum version
+    required: false
+    default: "false"
   major_pattern:
     description: "A string which, if present in a git commit, indicates that a change represents a major (breaking) change. Wrap with '/' to match using a regular expression."
     required: true
-    default: "(MAJOR)"
+    default: "/!:|BREAKING CHANGE:/"
+  major_regexp_flags:
+    description: "A string which indicates the flags used by the `major_pattern` regular expression. Supported flags: idgs"
+    required: false
+    default: ""
   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: "(MINOR)"
+    default: "/feat:/"
+  minor_regexp_flags:
+    description: "A string which indicates the flags used by the `minor_pattern` regular expression. Supported flags: idgs"
+    required: false
+    default: ""
   version_format:
     description: "Pattern to use when formatting output version"
     required: true
@@ -42,6 +58,18 @@ inputs:
     description: "The output method used to generate list of users, 'csv' or 'json'. Default is 'csv'."
     required: true
     default: "csv"
+  enable_prerelease_mode:
+    description: "Prevents pre-v1.0.0 version from automatically incrementing the major version. If enabled, when the major version is 0, major releases will be treated as minor and minor as patch. Note that the version_type output is unchanged."
+    required: true
+    default: "false"
+  bump_each_commit_patch_pattern:
+    description: "If bump_each_commit is also set to true, setting this value will cause the version to increment only if the pattern specified is matched."
+    required: true
+    default: ""
+  debug:
+    description: "If enabled, diagnostic information will be added to the action output"
+    required: true
+    default: "false"
 outputs:
   major:
     description: "Current major number"
@@ -51,14 +79,27 @@ outputs:
     description: "Current patch number"
   increment:
     description: "An additional value indicating the number of commits for the current version"
+  version_type:
+    description: "Indicates the type of change this version represents vs the previous, e.g. 'major', 'minor', 'patch', or 'none'"
   version:
     description: "The version result, in the format {major}.{minor}.{patch}"
   version_tag:
     description: "The version tag"
   changed:
     description: "Indicates whether there was a change since the last version if change_path was specified. If no change_path was specified this value will always be true since the entire repo is considered."
+  is_tagged:
+    description: "Indicates that the commit had a tag that matched the 'versionTag' format"
   authors:
     description: "List of users contributing commits to this version"
+  previous_commit:
+    description: "Hash of the previous commit"
+  previous_version:
+    description: "Indicates the previous version"
+  current_commit:
+    description: "The current commit hash"
+  debug_output:
+    description: "Diagnostic information, if debug is enabled"
+  
 runs:
-  using: "node16"
+  using: "node20"
   main: "dist/index.js"

contributing.md

@@ -0,0 +1,105 @@
+# Contributing
+
+Fixes and enhancements are welcome, but if you are planning to do a lot of work, it is a good idea to raise an issue first to discuss it. Generally enhancements should follow the goals of the project described in the main readme:
+
+- Allow the version to be injected into the build
+- Derive the version only from the git repository itself
+- Do not require the version to be maintained by hand
+- Resolve the version deterministically for a given commit
+- Provide an easy mechanism for incrementing major and minor versions by developers
+
+## Getting Help
+
+If you have found or believe you have found a bug please open a ticket. If you are having trouble using the action and need help please use the discussions page.
+
+Since nearly all questions are related to a specific repository it can be difficult to diagnose issues from a description alone. There are a few ways to provide additional information that can help diagnose the problem.
+
+### Creating Diagnostic Information
+
+There is a debug option which produces diagnostic information. This information can be used to troubleshoot and even to rerun the action without access to the original repository, for example with a debugger attached. To enable this option set the `debug` input to `true` and then use the `debug_output` output to access the information. The following configuration will print the debug output to the console:
+
+```
+- name: Version
+  uses: paulhatch/semantic-version@v5.4.0
+  id: version
+  with:
+    tag_prefix: ""
+    version_format: "${major}.${minor}.${patch}.${increment}"
+    debug: true
+
+- name: Print Diagnostic Output
+  run: echo "$DEBUG_OUTPUT"
+  env:
+    DEBUG_OUTPUT: ${{ steps.version.outputs.debug_output }}
+```
+
+Please review the information before posting it to avoid disclosing any sensitive information. In particular the output may contain names and email addresses of the committers, as well as commit messages for recent commits.
+
+### Providing a Test Case
+
+If you are planning to open a ticket or post to discussions, it is extremely helpful if you can provide a test case that demonstrates the problem. This project includes a test helper than makes it very easy to create new tests with just a few lines of code.
+
+To get started simply:
+
+- Ensure you have the latest version of NodeJS installed (https://nodejs.org)
+- Clone the repository, `git clone https://github.com/PaulHatch/semantic-version.git` or `git@github.com:PaulHatch/semantic-version.git`
+- Run `npm install` in the root of the repository to install the dependencies
+- Run `npm run test` to run the tests
+
+The src/main.test.ts file contains integration tests that validate all the features of this action, to add a new test case simply add a new function to the bottom of this file.
+
+```typescript
+test('Name of test goes here', async () => {
+    // This method creates a test repository in your temp directory, the repo
+    // object returned provides methods to interact with the repository
+    const repo = createTestRepo({
+        // Specify any config options you want to set, the options available can be found
+        // in the src/ActionConfig.ts file
+        tagPrefix: ''
+    });
+
+    // the make commit method creates a commit with the specified message, an empty file will be
+    // automatically created for the commit
+    repo.makeCommit('Initial Commit');
+
+    // an optional second parameter can be used to specify the path of the file to commit,
+    // which will be created if it does not exist already
+    repo.makeCommit('Initial Commit', 'subdir');
+    
+    // the exec method runs an arbitrary command in the repository
+    repo.exec('git tag 0.0.1')
+
+    // the runAction method runs the action and returns the result
+    const result = await repo.runAction();
+
+    // finally, the use whatever assertion you want to validate the result
+    expect(result.formattedVersion).toBe('0.0.1+0');
+}, 15000);
+```
+
+This uses the [Jest](https://jestjs.io/) testing framework. Really it is generally not necessary to be very familiar with Jest, just copy the pattern of the existing tests and you should be fine.
+
+Once you have a failing test case that demostrates the problem, you can just past it into the ticket, there is no need to create a repository unless you want to.
+
+
+### Providing an Example Repository
+
+If you are not able to provide a test case, it is still very helpful to provide an example repository that demonstrates the problem. Many times people are experiencing problems with a configuration of a private repository. This is quite difficult to debug without access to the repository, if you are able to provide a public repository that demonstrates the problem it will make it much easier to debug and can eliminate a great deal of back and forth.
+
+## Forking the Project
+
+If want to do something that does not fit with the project goals, particually if you want to include information from an outside system, it is probably best to fork the project and create your own action. One of the goals of this project starting in 5.0.0 is to be easy to fork and customize, and to that end the action has been broken into individual providers than can be replaced. All providers have been implemented using async calls specifically to support calls to external systems.
+
+The steps of this action are:
+
+- Get the current commit
+- Get the last release
+- Get commits between the last release and the current commit
+- Classify the release
+
+Additionally a few formatter provide modular behavior to these step:
+- A tag formmater is used to parse and format the version number
+- A version formatter is used to format output version string
+- A user formatter is used to format the user information in the output (JSON and CSV are provided in the default implementation)
+
+Each one includes at least one default, but can be replaced by a custom provider by implementing the appropriate interface and updating the `ConfigurationProvider` to return your action instead. This should allow you to continue to merge in changes from the main project as needed with minimal conflict.

dist/licenses.txt

@@ -82,3 +82,16 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

guide.md

@@ -0,0 +1,106 @@
+# Configuration Guide
+
+## Choosing a Release Strategy
+
+This section is designed to help you choose a release strategy for your project and help you configure GitHub Workflow to use that strategy. It is organized starting from the most simple with each strategy supporting more complex needs, allowing you to start at the top and continue until you find the simplest strategy that meets your needs.
+
+Note that in the examples given `latest` is used, but you will likely want to pin your version to a specific version.
+
+### Increment Every Release
+
+If your project has no gating requirements and you want to release every time a commit is pushed to the default branch, you can use the _Increment Every Release_ strategy. This may be appropriate for documentation projects, very small projects, or in cases where "shipping" a broken version isn't a big deal. The key limitation of this strategy is that once you push a commit, the version is going to increments no matter what. If you push a version and your build or automated tests fail, you'll have a version that is broken and you'll have to increment the version again to fix it.
+
+```yaml
+- uses: paulhatch/semantic-version@latest
+  with:
+    bump_each_commit: true
+```
+
+### Increment from Commit Message
+
+Very similar to the strategy above, using the _Increment from Commit Message_ means that you are making the decision to increment the version at the time you commit the code, however by using the `bump_each_commit_patch_pattern` parameter introduced in v5.1.0, you can prevent the version from incrementing for a commit unless it matches one of the patters (major, minor, or patch).
+
+Compared to the _Increment Every Release_ strategy, this strategy allows you to make a decision about whether or not to increment the version for a particular commit, allowing you to add commits to a repo that do not increment the version. Again, you make the decision to increment the version at the time you commit the code, so this strategy may not be appropriate for some project types.
+
+On the other hand, if you have a fast deployment strategy, such as "every commit goes to prod" and don't mind versions being created for failed builds, this may be the right choice.
+
+```yaml
+- uses: paulhatch/semantic-version@latest
+  with:
+    bump_each_commit: true
+    bump_each_commit_patch_pattern: "(PATCH)"
+```
+
+
+### Tag Versioning
+
+This strategy is the most common and is the best option for many projects. It allows you to make the decision to release a version after the build has run, which is essentially the primary motivation and main purpose for this action.
+
+The only real limitation of this strategy is that it does not allow for multiple versions to receive ongoing updates, which may be necessary for certain types of projects which are distributed and receive ongoing maintenance of older versions. This is in contrast to projects that are developed only for a single deployment and are not distributed.
+
+Tags should generally not be created automatically as part of the build, which can cause strange behavior unless you've taken care to prevent race conditions. Creating tags automatically also largely negates the purpose of this strategy.
+
+_This is the default behavior, so no special options are required._
+
+```yaml
+- uses: paulhatch/semantic-version@latest
+```
+
+
+### Branch + Tag Versioning
+
+So far all the options considered have assumed that a single, ever incrementing version is being released, and that once a new major or minor version is tagged no further updates are made for previous versions. This is appropriate for many projects such as web applications and most libraries, however if you need to support on-going update to multiple major or major+minor versions, using only the approaches above can lead to problems if you are merging updates into multiple branches, as any tags may be picked up and cause the version of an older branch to unexpectedly jump.
+
+To accomplish this, we can enable the `version_from_branch`, which will cause the major and optionally the minor version to be taken from the current branch name rather than the tag, and to filter out tags that do not begin with the same version number(s). The `version_from_branch` input can be either a boolean or a regex string to be used to identify the version from the branch name. By default this will be `[0-9]+.[0-9]+$|[0-9]+$` e.g. match the final number or pair of numbers separated by a `.`. This default is probably appropriate for the majority of cases as it will match any prefix, for example branches named:
+
+- `release/v1`
+- `release/v1.2`
+- `v1`
+- `v1.2`
+- `1`
+- `1.2`
+
+Note that when using this strategy you should always tag at the same time as the branch is created to ensure that the increment value is correct.
+
+```yaml
+- uses: paulhatch/semantic-version@latest
+  with:
+    version_from_branch: true
+```
+
+Alternately, you can override the branch pattern.
+
+```yaml
+- uses: paulhatch/semantic-version@latest
+  with:
+    version_from_branch: "/v([0-9]+.[0-9]+$|[0-9]+)$/"
+```
+
+## Namespace Services / "Monorepo" Support
+
+If your project contains multiple services which you wish to version independently, you can use the `namespace` and `change_path` inputs to provide a version for a specific service which increments only when a file in the specified path is changed. (Or, if you are only build on push/pull requests you can just use the GitHub Action's [`paths`/`paths-ignore`](https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onpushpull_requestpull_request_targetpathspaths-ignore) feature to block the trigger itself and run the workflow only when files in a specific path are changed. In contrast this method will also work on other triggers like `workflow_dispatch`.)
+
+```yaml
+- id: version
+  uses: paulhatch/semantic-version@latest
+  with:
+    change_path: "src/my-service"
+    namespace: my-service
+- name: Cancel if Unchanged
+  if: ${{ ! fromJSON(steps.version.outputs.changed) }}
+  run: |
+    gh run cancel ${{ github.run_id }}
+    gh run watch ${{ github.run_id }}
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Additional Configuration
+
+| 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. |
+| `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. |

lib/ActionConfig.js

@@ -8,10 +8,18 @@ class ActionConfig {
         this.branch = "HEAD";
         /** The prefix to use to identify tags */
         this.tagPrefix = "v";
+        /** (Deprecated) Use branches instead of tags */
+        this.useBranches = false;
+        /** If true, the branch will be used to select the maximum version. */
+        this.versionFromBranch = false;
         /** A string which, if present in a git commit, indicates that a change represents a major (breaking) change. Wrap with '/' to match using a regular expression. */
-        this.majorPattern = "(MAJOR)";
+        this.majorPattern = "/!:|BREAKING CHANGE:/";
+        /** A string which indicates the flags used by the `majorPattern` regular expression. */
+        this.majorFlags = "";
         /** 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. */
-        this.minorPattern = "(MINOR)";
+        this.minorPattern = "/feat:/";
+        /** A string which indicates the flags used by the `minorPattern` regular expression. */
+        this.minorFlags = "";
         /** Pattern to use when formatting output version */
         this.versionFormat = '${major}.${minor}.${patch}';
         /** Path to check for changes. If any changes are detected in the path the 'changed' output will true. Enter multiple paths separated by spaces. */
@@ -24,6 +32,14 @@ class ActionConfig {
         this.searchCommitBody = false;
         /** The output method used to generate list of users, 'csv' or 'json'. Default is 'csv'. */
         this.userFormatType = "csv";
+        /** Prevents pre-v1.0.0 version from automatically incrementing the major version. If enabled, when the major version is 0, major releases will be treated as minor and minor as patch. Note that the versionType output is unchanged.  */
+        this.enablePrereleaseMode = false;
+        /** If bump_each_commit is also set to true, setting this value will cause the version to increment only if the pattern specified is matched. */
+        this.bumpEachCommitPatchPattern = "";
+        /** If enabled, diagnostic information will be added to the action output. */
+        this.debug = false;
+        /** Diagnostics to replay */
+        this.replay = '';
     }
 }
 exports.ActionConfig = ActionConfig;

lib/CommandRunner.js

@@ -35,7 +35,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cmd = void 0;
 // Using require instead of import to support integration testing
 const exec = __importStar(require("@actions/exec"));
+const DebugManager_1 = require("./DebugManager");
 const cmd = (command, ...args) => __awaiter(void 0, void 0, void 0, function* () {
+    const debugManager = DebugManager_1.DebugManager.getInstance();
+    if (debugManager.isReplayMode()) {
+        return debugManager.replayCommand(command, args);
+    }
     let output = '', errors = '';
     const options = {
         silent: true,
@@ -46,15 +51,14 @@ const cmd = (command, ...args) => __awaiter(void 0, void 0, void 0, function* ()
             silent: true
         }
     };
+    let caughtError = null;
     try {
         yield exec.exec(command, args, options);
     }
     catch (err) {
-        //core.info(`The command cd '${command} ${args.join(' ')}' failed: ${err}`);
-    }
-    if (errors !== '') {
-        //core.info(`stderr: ${errors}`);
+        caughtError = err;
     }
+    debugManager.recordCommand(command, args, output, errors, caughtError);
     return output;
 });
 exports.cmd = cmd;

lib/ConfigurationProvider.js

@@ -2,20 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationProvider = void 0;
 const CsvUserFormatter_1 = require("./formatting/CsvUserFormatter");
+const BranchVersioningTagFormatter_1 = require("./formatting/BranchVersioningTagFormatter");
 const DefaultTagFormatter_1 = require("./formatting/DefaultTagFormatter");
 const DefaultVersionFormatter_1 = require("./formatting/DefaultVersionFormatter");
 const JsonUserFormatter_1 = require("./formatting/JsonUserFormatter");
 const DefaultCommitsProvider_1 = require("./providers/DefaultCommitsProvider");
 const DefaultCurrentCommitResolver_1 = require("./providers/DefaultCurrentCommitResolver");
 const DefaultVersionClassifier_1 = require("./providers/DefaultVersionClassifier");
-const TagLastReleaseResolver_1 = require("./providers/TagLastReleaseResolver");
+const DefaultLastReleaseResolver_1 = require("./providers/DefaultLastReleaseResolver");
 const BumpAlwaysVersionClassifier_1 = require("./providers/BumpAlwaysVersionClassifier");
+const DebugManager_1 = require("./DebugManager");
 class ConfigurationProvider {
     constructor(config) {
         this.config = config;
+        DebugManager_1.DebugManager.getInstance().initializeConfig(config);
     }
     GetCurrentCommitResolver() { return new DefaultCurrentCommitResolver_1.DefaultCurrentCommitResolver(this.config); }
-    GetLastReleaseResolver() { return new TagLastReleaseResolver_1.TagLastReleaseResolver(this.config); }
+    GetLastReleaseResolver() { return new DefaultLastReleaseResolver_1.DefaultLastReleaseResolver(this.config); }
     GetCommitsProvider() { return new DefaultCommitsProvider_1.DefaultCommitsProvider(this.config); }
     GetVersionClassifier() {
         if (this.config.bumpEachCommit) {
@@ -24,7 +27,12 @@ class ConfigurationProvider {
         return new DefaultVersionClassifier_1.DefaultVersionClassifier(this.config);
     }
     GetVersionFormatter() { return new DefaultVersionFormatter_1.DefaultVersionFormatter(this.config); }
-    GetTagFormatter() { return new DefaultTagFormatter_1.DefaultTagFormatter(this.config); }
+    GetTagFormatter(branchName) {
+        if (this.config.versionFromBranch) {
+            return new BranchVersioningTagFormatter_1.BranchVersioningTagFormatter(this.config, branchName);
+        }
+        return new DefaultTagFormatter_1.DefaultTagFormatter(this.config);
+    }
     GetUserFormatter() {
         switch (this.config.userFormatType) {
             case 'json': return new JsonUserFormatter_1.JsonUserFormatter(this.config);

lib/DebugManager.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebugManager = void 0;
+/** Utility class for managing debug mode and diagnostic information */
+class DebugManager {
+    constructor() {
+        this.debugEnabled = false;
+        this.replayMode = false;
+        this.diagnosticInfo = null;
+    }
+    /** Returns the singleton instance of the DebugManager */
+    static getInstance() {
+        if (!DebugManager.instance) {
+            DebugManager.instance = new DebugManager();
+        }
+        return DebugManager.instance;
+    }
+    /** Clears the singleton instance of the DebugManager (used for testing) */
+    static clearState() {
+        DebugManager.instance = new DebugManager();
+    }
+    /** Returns true if debug mode is enabled */
+    isDebugEnabled() {
+        return this.debugEnabled;
+    }
+    /** Returns true if replay mode is enabled */
+    isReplayMode() {
+        return this.replayMode;
+    }
+    initializeConfig(config) {
+        if (config.debug) {
+            this.setDebugEnabled(true);
+        }
+        else if (config.replay.length > 0) {
+            this.replayFromDiagnostics(config.replay);
+        }
+    }
+    /** Enables or disables debug mode, also clears any existing diagnostics info */
+    setDebugEnabled(enableDebug = true) {
+        this.debugEnabled = enableDebug;
+        this.replayMode = false;
+        this.diagnosticInfo = new DiagnosticInfo();
+    }
+    ;
+    /** Enables replay mode and loads the diagnostic information from the specified string */
+    replayFromDiagnostics(diagnostics) {
+        this.debugEnabled = false;
+        this.replayMode = true;
+        this.diagnosticInfo = JSON.parse(diagnostics);
+    }
+    /** Returns a JSON string containing the diagnostic information for this run */
+    getDebugOutput(emptyRepo = false) {
+        return this.isDebugEnabled() ? JSON.stringify(this.diagnosticInfo) : '';
+    }
+    /** Records a command and its output for diagnostic purposes */
+    recordCommand(command, args, output, stderr, error) {
+        var _a;
+        if (this.isDebugEnabled()) {
+            (_a = this.diagnosticInfo) === null || _a === void 0 ? void 0 : _a.recordCommand(command, args, output, stderr, error);
+        }
+    }
+    /** Replays the specified command and returns the output */
+    replayCommand(command, args) {
+        if (this.diagnosticInfo === null) {
+            throw new Error('No diagnostic information available for replay');
+        }
+        const commandResult = this.diagnosticInfo.commands.find(c => c.command === command && JSON.stringify(c.args) === JSON.stringify(args));
+        if (!commandResult) {
+            throw new Error(`No result found in diagnostic for command "${command}"`);
+        }
+        if (commandResult.error) {
+            throw commandResult.error;
+        }
+        if (commandResult.stderr) {
+            console.error(commandResult.stderr);
+        }
+        return commandResult.output;
+    }
+}
+exports.DebugManager = DebugManager;
+/** Represents a CLI command result */
+class CommandResult {
+    constructor(command, args, output, stderr, error) {
+        this.command = command;
+        this.args = args;
+        this.output = output;
+        this.stderr = stderr;
+        this.error = error;
+    }
+}
+/** Represents the result of the commands executed for a run */
+class DiagnosticInfo {
+    constructor() {
+        this.commands = [];
+        this.empty = false;
+    }
+    recordCommand(command, args, output, stderr, error) {
+        this.commands.push(new CommandResult(command, args, output, stderr, error));
+    }
+}

lib/VersionResult.js

@@ -9,26 +9,32 @@ class VersionResult {
      * @param minor - The minor version number
      * @param patch - The patch version number
      * @param increment - The number of commits for this version (usually used to create version suffix)
+     * @param versionType - The type of version, e.g. major, minor, patch
      * @param formattedVersion - The formatted semantic version
      * @param versionTag - The string to be used as a Git tag
      * @param changed - True if the version was changed, otherwise false
+     * @param isTagged - True if the commit had a tag that matched the `versionTag` format
      * @param authors - Authors formatted according to the format mode (e.g. JSON, CSV, YAML, etc.)
      * @param currentCommit - The current commit hash
      * @param previousCommit - The previous commit hash
-     * @param previousVersion - the previous version
+     * @param previousVersion - The previous version
+     * @param debugOutput - Diagnostic information, if debug is enabled
      */
-    constructor(major, minor, patch, increment, formattedVersion, versionTag, changed, authors, currentCommit, previousCommit, previousVersion) {
+    constructor(major, minor, patch, increment, versionType, formattedVersion, versionTag, changed, isTagged, authors, currentCommit, previousCommit, previousVersion, debugOutput) {
         this.major = major;
         this.minor = minor;
         this.patch = patch;
         this.increment = increment;
+        this.versionType = versionType;
         this.formattedVersion = formattedVersion;
         this.versionTag = versionTag;
         this.changed = changed;
+        this.isTagged = isTagged;
         this.authors = authors;
         this.currentCommit = currentCommit;
         this.previousCommit = previousCommit;
         this.previousVersion = previousVersion;
+        this.debugOutput = debugOutput;
     }
 }
 exports.VersionResult = VersionResult;

lib/action.js

@@ -14,6 +14,7 @@ const VersionResult_1 = require("./VersionResult");
 const VersionType_1 = require("./providers/VersionType");
 const UserInfo_1 = require("./providers/UserInfo");
 const VersionInformation_1 = require("./providers/VersionInformation");
+const DebugManager_1 = require("./DebugManager");
 function runAction(configurationProvider) {
     return __awaiter(this, void 0, void 0, function* () {
         const currentCommitResolver = configurationProvider.GetCurrentCommitResolver();
@@ -21,20 +22,22 @@ function runAction(configurationProvider) {
         const commitsProvider = configurationProvider.GetCommitsProvider();
         const versionClassifier = configurationProvider.GetVersionClassifier();
         const versionFormatter = configurationProvider.GetVersionFormatter();
-        const tagFormmater = configurationProvider.GetTagFormatter();
+        const tagFormatter = configurationProvider.GetTagFormatter(yield currentCommitResolver.ResolveBranchNameAsync());
         const userFormatter = configurationProvider.GetUserFormatter();
+        const debugManager = DebugManager_1.DebugManager.getInstance();
         if (yield currentCommitResolver.IsEmptyRepoAsync()) {
-            let versionInfo = new VersionInformation_1.VersionInformation(0, 0, 0, 0, VersionType_1.VersionType.None, [], false);
-            return new VersionResult_1.VersionResult(versionInfo.major, versionInfo.minor, versionInfo.patch, versionInfo.increment, versionFormatter.Format(versionInfo), tagFormmater.Format(versionInfo), versionInfo.changed, userFormatter.Format('author', []), '', '', '0.0.0');
+            const versionInfo = new VersionInformation_1.VersionInformation(0, 0, 0, 0, VersionType_1.VersionType.None, [], false, false);
+            return new VersionResult_1.VersionResult(versionInfo.major, versionInfo.minor, versionInfo.patch, versionInfo.increment, versionInfo.type, versionFormatter.Format(versionInfo), tagFormatter.Format(versionInfo), versionInfo.changed, versionInfo.isTagged, userFormatter.Format('author', []), '', '', tagFormatter.Parse(tagFormatter.Format(versionInfo)).join('.'), debugManager.getDebugOutput(true));
         }
         const currentCommit = yield currentCommitResolver.ResolveAsync();
-        const lastRelease = yield lastReleaseResolver.ResolveAsync(currentCommit, tagFormmater);
+        const lastRelease = yield lastReleaseResolver.ResolveAsync(currentCommit, tagFormatter);
         const commitSet = yield commitsProvider.GetCommitsAsync(lastRelease.hash, currentCommit);
         const classification = yield versionClassifier.ClassifyAsync(lastRelease, commitSet);
+        const { isTagged } = lastRelease;
         const { major, minor, patch, increment, type, changed } = classification;
         // At this point all necessary data has been pulled from the database, create
         // version information to be used by the formatters
-        let versionInfo = new VersionInformation_1.VersionInformation(major, minor, patch, increment, type, commitSet.commits, changed);
+        let versionInfo = new VersionInformation_1.VersionInformation(major, minor, patch, increment, type, commitSet.commits, changed, isTagged);
         // Group all the authors together, count the number of commits per author
         const allAuthors = versionInfo.commits
             .reduce((acc, commit) => {
@@ -46,7 +49,7 @@ function runAction(configurationProvider) {
         const authors = Object.values(allAuthors)
             .map((u) => new UserInfo_1.UserInfo(u.n, u.e, u.c))
             .sort((a, b) => b.commits - a.commits);
-        return new VersionResult_1.VersionResult(versionInfo.major, versionInfo.minor, versionInfo.patch, versionInfo.increment, versionFormatter.Format(versionInfo), tagFormmater.Format(versionInfo), versionInfo.changed, userFormatter.Format('author', authors), currentCommit, lastRelease.hash, `${lastRelease.major}.${lastRelease.minor}.${lastRelease.patch}`);
+        return new VersionResult_1.VersionResult(versionInfo.major, versionInfo.minor, versionInfo.patch, versionInfo.increment, versionInfo.type, versionFormatter.Format(versionInfo), tagFormatter.Format(versionInfo), versionInfo.changed, versionInfo.isTagged, userFormatter.Format('author', authors), currentCommit, lastRelease.hash, `${lastRelease.major}.${lastRelease.minor}.${lastRelease.patch}`, debugManager.getDebugOutput());
     });
 }
 exports.runAction = runAction;

lib/formatting/BranchVersioningTagFormatter.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BranchVersioningTagFormatter = void 0;
+const DefaultTagFormatter_1 = require("./DefaultTagFormatter");
+/** Default tag formatter which allows a prefix to be specified */
+class BranchVersioningTagFormatter extends DefaultTagFormatter_1.DefaultTagFormatter {
+    getRegex(pattern) {
+        if (/^\/.+\/[i]*$/.test(pattern)) {
+            const regexEnd = pattern.lastIndexOf('/');
+            const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
+            return new RegExp(pattern.slice(1, regexEnd), parsedFlags);
+        }
+        return new RegExp(pattern);
+    }
+    constructor(config, branchName) {
+        super(config);
+        const pattern = config.versionFromBranch === true ?
+            new RegExp("[0-9]+.[0-9]+$|[0-9]+$") :
+            this.getRegex(config.versionFromBranch);
+        const result = pattern.exec(branchName);
+        if (result === null) {
+            this.major = NaN;
+            this.onVersionBranch = false;
+            return;
+        }
+        let branchVersion;
+        switch (result === null || result === void 0 ? void 0 : result.length) {
+            case 1:
+                branchVersion = result[0];
+                break;
+            case 2:
+                branchVersion = result[1];
+                break;
+            default:
+                throw new Error(`Unable to parse version from branch named '${branchName}' using pattern '${pattern}'`);
+        }
+        this.onVersionBranch = true;
+        const versionValues = branchVersion.split('.');
+        if (versionValues.length > 2) {
+            throw new Error(`The version string '${branchVersion}' parsed from branch '${branchName}' is invalid. It must be in the format 'major.minor' or 'major'`);
+        }
+        this.major = parseInt(versionValues[0]);
+        if (isNaN(this.major)) {
+            throw new Error(`The major version '${versionValues[0]}' parsed from branch '${branchName}' is invalid. It must be a number.`);
+        }
+        if (versionValues.length > 1) {
+            this.minor = parseInt(versionValues[1]);
+            if (isNaN(this.minor)) {
+                throw new Error(`The minor version '${versionValues[1]}' parsed from branch '${branchName}' is invalid. It must be a number.`);
+            }
+        }
+    }
+    GetPattern() {
+        let pattern = super.GetPattern();
+        if (!this.onVersionBranch) {
+            return pattern;
+        }
+        if (this.minor === undefined) {
+            return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.*[0-9].*[0-9]`);
+        }
+        return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.${this.minor}.*[0-9]`);
+    }
+    IsValid(tag) {
+        if (!this.onVersionBranch) {
+            return super.IsValid(tag);
+        }
+        if (!super.IsValid(tag)) {
+            return false;
+        }
+        const parsed = super.Parse(tag);
+        if (parsed[0] !== this.major) {
+            return false;
+        }
+        if (this.minor !== undefined && parsed[1] !== this.minor) {
+            return false;
+        }
+        return true;
+    }
+    Parse(tag) {
+        if (!this.onVersionBranch) {
+            return super.Parse(tag);
+        }
+        const parsed = super.Parse(tag);
+        return [this.major, this.minor || parsed[1], parsed[2]];
+    }
+}
+exports.BranchVersioningTagFormatter = BranchVersioningTagFormatter;

lib/formatting/DefaultTagFormatter.js

@@ -22,18 +22,16 @@ class DefaultTagFormatter {
         return `${this.tagPrefix}*[0-9].*[0-9].*[0-9]`;
     }
     Parse(tag) {
-        let stripedTag;
-        if (this.tagPrefix.includes('/') && tag.includes(this.tagPrefix)) {
-            let tagParts = tag
-                .replace(this.tagPrefix, '<--!PREFIX!-->')
-                .split('/');
-            stripedTag = tagParts[tagParts.length - 1]
-                .replace('<--!PREFIX!-->', this.tagPrefix);
-        }
-        else {
-            let tagParts = tag.split('/');
-            stripedTag = tagParts[tagParts.length - 1];
+        if (tag === '') {
+            return [0, 0, 0];
         }
+        let tagParts = tag
+            .replace(this.tagPrefix, '<--!PREFIX!-->')
+            .replace(this.namespace, '<--!NAMESPACE!-->')
+            .split('/');
+        const stripedTag = tagParts[tagParts.length - 1]
+            .replace('<--!PREFIX!-->', this.tagPrefix)
+            .replace('<--!NAMESPACE!-->', this.namespace);
         let versionValues = stripedTag
             .substring(this.tagPrefix.length)
             .slice(0, this.namespace === '' ? 999 : -(this.namespace.length + 1))
@@ -47,5 +45,15 @@ class DefaultTagFormatter {
         return [major, minor, patch];
     }
     ;
+    IsValid(tag) {
+        const regexEscape = (literal) => literal.replace(/\W/g, '\\$&');
+        const tagPrefix = regexEscape(this.tagPrefix);
+        const namespaceSeperator = regexEscape(this.namespaceSeperator);
+        const namespace = regexEscape(this.namespace);
+        if (!!this.namespace) {
+            return new RegExp(`^${tagPrefix}[0-9]+\.[0-9]+\.[0-9]+${namespaceSeperator}${namespace}$`).test(tag);
+        }
+        return new RegExp(`^${tagPrefix}[0-9]+\.[0-9]+\.[0-9]+$`).test(tag);
+    }
 }
 exports.DefaultTagFormatter = DefaultTagFormatter;

lib/main.js

@@ -36,8 +36,9 @@ exports.run = void 0;
 const action_1 = require("./action");
 const ConfigurationProvider_1 = require("./ConfigurationProvider");
 const core = __importStar(require("@actions/core"));
+const VersionType_1 = require("./providers/VersionType");
 function setOutput(versionResult) {
-    const { major, minor, patch, increment, formattedVersion, versionTag, changed, authors, currentCommit, previousCommit, previousVersion } = versionResult;
+    const { major, minor, patch, increment, versionType, formattedVersion, versionTag, changed, isTagged, authors, currentCommit, previousCommit, previousVersion, debugOutput } = versionResult;
     const repository = process.env.GITHUB_REPOSITORY;
     if (!changed) {
         core.info('No changes detected for this commit');
@@ -51,27 +52,59 @@ function setOutput(versionResult) {
     core.setOutput("minor", minor.toString());
     core.setOutput("patch", patch.toString());
     core.setOutput("increment", increment.toString());
+    core.setOutput("version_type", VersionType_1.VersionType[versionType].toLowerCase());
     core.setOutput("changed", changed.toString());
+    core.setOutput("is_tagged", isTagged.toString());
     core.setOutput("version_tag", versionTag);
     core.setOutput("authors", authors);
-    core.setOutput("lastVersion", authors);
     core.setOutput("previous_commit", previousCommit);
     core.setOutput("previous_version", previousVersion);
+    core.setOutput("current_commit", currentCommit);
+    core.setOutput("debug_output", debugOutput);
 }
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
+        function toBool(value) {
+            if (!value || value.toLowerCase() === 'false') {
+                return false;
+            }
+            else if (value.toLowerCase() === 'true') {
+                return true;
+            }
+            return false;
+        }
+        function toStringOrBool(value) {
+            if (!value || value === 'false') {
+                return false;
+            }
+            if (value === 'true') {
+                return true;
+            }
+            return value;
+        }
         const config = {
             branch: core.getInput('branch'),
             tagPrefix: core.getInput('tag_prefix'),
+            useBranches: toBool(core.getInput('use_branches')),
+            versionFromBranch: toStringOrBool(core.getInput('version_from_branch')),
             majorPattern: core.getInput('major_pattern'),
             minorPattern: core.getInput('minor_pattern'),
+            majorFlags: core.getInput('major_regexp_flags'),
+            minorFlags: core.getInput('minor_regexp_flags'),
             versionFormat: core.getInput('version_format'),
             changePath: core.getInput('change_path'),
             namespace: core.getInput('namespace'),
-            bumpEachCommit: core.getInput('bump_each_commit') === 'true',
-            searchCommitBody: core.getInput('search_commit_body') === 'true',
-            userFormatType: core.getInput('user_format_type')
+            bumpEachCommit: toBool(core.getInput('bump_each_commit')),
+            searchCommitBody: toBool(core.getInput('search_commit_body')),
+            userFormatType: core.getInput('user_format_type'),
+            enablePrereleaseMode: toBool(core.getInput('enable_prerelease_mode')),
+            bumpEachCommitPatchPattern: core.getInput('bump_each_commit_patch_pattern'),
+            debug: toBool(core.getInput('debug')),
+            replay: ''
         };
+        if (config.useBranches) {
+            core.warning(`The 'use_branches' input option is deprecated, please see the documentation for more information on how to use branches`);
+        }
         if (config.versionFormat === '' && core.getInput('format') !== '') {
             core.warning(`The 'format' input is deprecated, use 'versionFormat' instead`);
             config.versionFormat = core.getInput('format');

lib/providers/BumpAlwaysVersionClassifier.js

@@ -16,7 +16,10 @@ const VersionType_1 = require("./VersionType");
 class BumpAlwaysVersionClassifier extends DefaultVersionClassifier_1.DefaultVersionClassifier {
     constructor(config) {
         super(config);
-        // Placeholder for consistency
+        this.enablePrereleaseMode = config.enablePrereleaseMode;
+        this.patchPattern = !config.bumpEachCommitPatchPattern ?
+            _ => true :
+            this.parsePattern(config.bumpEachCommitPatchPattern, "", config.searchCommitBody);
     }
     ClassifyAsync(lastRelease, commitSet) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -25,27 +28,64 @@ class BumpAlwaysVersionClassifier extends DefaultVersionClassifier_1.DefaultVers
             }
             let { major, minor, patch } = lastRelease;
             let type = VersionType_1.VersionType.None;
+            let increment = 0;
             if (commitSet.commits.length === 0) {
                 return new VersionClassification_1.VersionClassification(type, 0, false, major, minor, patch);
             }
             for (let commit of commitSet.commits.reverse()) {
                 if (this.majorPattern(commit)) {
-                    major += 1;
-                    minor = 0;
-                    patch = 0;
                     type = VersionType_1.VersionType.Major;
                 }
                 else if (this.minorPattern(commit)) {
-                    minor += 1;
-                    patch = 0;
                     type = VersionType_1.VersionType.Minor;
                 }
-                else {
-                    patch += 1;
+                else if (this.patchPattern(commit) ||
+                    (major === 0 && minor === 0 && patch === 0 && commitSet.commits.length > 0)) {
                     type = VersionType_1.VersionType.Patch;
                 }
+                else {
+                    type = VersionType_1.VersionType.None;
+                }
+                if (this.enablePrereleaseMode && major === 0) {
+                    switch (type) {
+                        case VersionType_1.VersionType.Major:
+                        case VersionType_1.VersionType.Minor:
+                            minor += 1;
+                            patch = 0;
+                            increment = 0;
+                            break;
+                        case VersionType_1.VersionType.Patch:
+                            patch += 1;
+                            increment = 0;
+                            break;
+                        default:
+                            increment++;
+                            break;
+                    }
+                }
+                else {
+                    switch (type) {
+                        case VersionType_1.VersionType.Major:
+                            major += 1;
+                            minor = 0;
+                            patch = 0;
+                            increment = 0;
+                            break;
+                        case VersionType_1.VersionType.Minor:
+                            minor += 1;
+                            patch = 0;
+                            break;
+                        case VersionType_1.VersionType.Patch:
+                            patch += 1;
+                            increment = 0;
+                            break;
+                        default:
+                            increment++;
+                            break;
+                    }
+                }
             }
-            return new VersionClassification_1.VersionClassification(type, 0, true, major, minor, patch);
+            return new VersionClassification_1.VersionClassification(type, increment, true, major, minor, patch);
         });
     }
 }

lib/providers/DefaultCurrentCommitResolver.js

@@ -29,5 +29,11 @@ class DefaultCurrentCommitResolver {
             return lastCommitAll === '';
         });
     }
+    ResolveBranchNameAsync() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const branchName = this.branch == 'HEAD' ? yield (0, CommandRunner_1.cmd)('git', 'rev-parse', '--abbrev-ref', 'HEAD') : this.branch;
+            return branchName.trim();
+        });
+    }
 }
 exports.DefaultCurrentCommitResolver = DefaultCurrentCommitResolver;

lib/providers/DefaultLastReleaseResolver.js

@@ -0,0 +1,99 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultLastReleaseResolver = void 0;
+const CommandRunner_1 = require("../CommandRunner");
+const ReleaseInformation_1 = require("./ReleaseInformation");
+const core = __importStar(require("@actions/core"));
+class DefaultLastReleaseResolver {
+    constructor(config) {
+        this.changePath = config.changePath;
+        this.useBranches = config.useBranches;
+    }
+    ResolveAsync(current, tagFormatter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const releasePattern = tagFormatter.GetPattern();
+            let currentTag = (yield (0, CommandRunner_1.cmd)(`git tag --points-at ${current} ${releasePattern}`)).trim();
+            currentTag = tagFormatter.IsValid(currentTag) ? currentTag : '';
+            const isTagged = currentTag !== '';
+            const [currentMajor, currentMinor, currentPatch] = !!currentTag ? tagFormatter.Parse(currentTag) : [null, null, null];
+            let tagsCount = 0;
+            let tag = '';
+            try {
+                const refPrefixPattern = this.useBranches ? 'refs/heads/' : 'refs/tags/';
+                if (!!currentTag) {
+                    // If we already have the current branch tagged, we are checking for the previous one
+                    // so that we will have an accurate increment (assuming the new tag is the expected one)
+                    const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
+                    const tags = (yield (0, CommandRunner_1.cmd)(command)).split('\n');
+                    tagsCount = tags.length;
+                    tag = tags
+                        .find(t => tagFormatter.IsValid(t) && t !== currentTag) || '';
+                }
+                else {
+                    const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
+                    const tags = (yield (0, CommandRunner_1.cmd)(command)).split('\n');
+                    tagsCount = tags.length;
+                    tag = tags
+                        .find(t => tagFormatter.IsValid(t)) || '';
+                }
+                tag = tag.trim();
+            }
+            catch (err) {
+                tag = '';
+            }
+            if (tag === '') {
+                if ((yield (0, CommandRunner_1.cmd)('git', 'remote')) !== '') {
+                    // Since there is no remote, we assume that there are no other tags to pull. In
+                    // practice this isn't likely to happen, but it keeps the test output from being
+                    // polluted with a bunch of warnings.
+                    if (tagsCount > 0) {
+                        core.warning(`None of the ${tagsCount} tags(s) found were valid version tags for the present configuration. If this is unexpected, check to ensure that the configuration is correct and matches the tag format you are using.`);
+                    }
+                    else {
+                        core.warning('No tags are present for this repository. If this is unexpected, check to ensure that tags have been pulled from the remote.');
+                    }
+                }
+                const [major, minor, patch] = tagFormatter.Parse('');
+                // no release tags yet, use the initial commit as the root
+                return new ReleaseInformation_1.ReleaseInformation(major, minor, patch, '', currentMajor, currentMinor, currentPatch, isTagged);
+            }
+            // parse the version tag
+            const [major, minor, patch] = tagFormatter.Parse(tag);
+            const root = yield (0, CommandRunner_1.cmd)('git', `merge-base`, tag, current);
+            return new ReleaseInformation_1.ReleaseInformation(major, minor, patch, root.trim(), currentMajor, currentMinor, currentPatch, isTagged);
+        });
+    }
+}
+exports.DefaultLastReleaseResolver = DefaultLastReleaseResolver;

lib/providers/DefaultVersionClassifier.js

@@ -15,12 +15,15 @@ const VersionType_1 = require("./VersionType");
 class DefaultVersionClassifier {
     constructor(config) {
         const searchBody = config.searchCommitBody;
-        this.majorPattern = this.parsePattern(config.majorPattern, searchBody);
-        this.minorPattern = this.parsePattern(config.minorPattern, searchBody);
+        this.majorPattern = this.parsePattern(config.majorPattern, config.majorFlags, searchBody);
+        this.minorPattern = this.parsePattern(config.minorPattern, config.minorFlags, searchBody);
+        this.enablePrereleaseMode = config.enablePrereleaseMode;
     }
-    parsePattern(pattern, searchBody) {
-        if (pattern.startsWith('/') && pattern.endsWith('/')) {
-            var regex = new RegExp(pattern.slice(1, -1));
+    parsePattern(pattern, flags, searchBody) {
+        if (/^\/.+\/[i]*$/.test(pattern)) {
+            const regexEnd = pattern.lastIndexOf('/');
+            const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
+            const regex = new RegExp(pattern.slice(1, regexEnd), parsedFlags || flags);
             return searchBody ?
                 (commit) => regex.test(commit.subject) || regex.test(commit.body) :
                 (commit) => regex.test(commit.subject);
@@ -33,6 +36,19 @@ class DefaultVersionClassifier {
         }
     }
     getNextVersion(current, type) {
+        if (this.enablePrereleaseMode && current.major === 0) {
+            switch (type) {
+                case VersionType_1.VersionType.Major:
+                    return { major: current.major, minor: current.minor + 1, patch: 0 };
+                case VersionType_1.VersionType.Minor:
+                case VersionType_1.VersionType.Patch:
+                    return { major: current.major, minor: current.minor, patch: current.patch + 1 };
+                case VersionType_1.VersionType.None:
+                    return { major: current.major, minor: current.minor, patch: current.patch };
+                default:
+                    throw new Error(`Unknown change type: ${type}`);
+            }
+        }
         switch (type) {
             case VersionType_1.VersionType.Major:
                 return { major: current.major + 1, minor: 0, patch: 0 };
@@ -80,8 +96,8 @@ class DefaultVersionClassifier {
                 // - commit 3 was tagged v2.0.0 - v2.0.0+0
                 // - commit 4 - v2.0.1+0
                 const versionsMatch = lastRelease.currentMajor === major && lastRelease.currentMinor === minor && lastRelease.currentPatch === patch;
-                const currentIncremement = versionsMatch ? increment : 0;
-                return new VersionClassification_1.VersionClassification(VersionType_1.VersionType.None, currentIncremement, false, lastRelease.currentMajor, lastRelease.currentMinor, lastRelease.currentPatch);
+                const currentIncrement = versionsMatch ? increment : 0;
+                return new VersionClassification_1.VersionClassification(VersionType_1.VersionType.None, currentIncrement, false, lastRelease.currentMajor, lastRelease.currentMinor, lastRelease.currentPatch);
             }
             return new VersionClassification_1.VersionClassification(type, increment, changed, major, minor, patch);
         });

lib/providers/ReleaseInformation.js

@@ -12,8 +12,9 @@ class ReleaseInformation {
      * @param currentMajor - the major version number from the current commit
      * @param currentMinor - the minor version number from the current commit
      * @param currentPatch - the patch version number from the current commit
+     * @param isTagged - whether the current commit is tagged with a version
      */
-    constructor(major, minor, patch, hash, currentMajor, currentMinor, currentPatch) {
+    constructor(major, minor, patch, hash, currentMajor, currentMinor, currentPatch, isTagged) {
         this.major = major;
         this.minor = minor;
         this.patch = patch;
@@ -21,6 +22,7 @@ class ReleaseInformation {
         this.currentMajor = currentMajor;
         this.currentMinor = currentMinor;
         this.currentPatch = currentPatch;
+        this.isTagged = isTagged;
     }
 }
 exports.ReleaseInformation = ReleaseInformation;

lib/providers/VersionInformation.js

@@ -15,8 +15,9 @@ class VersionInformation {
      * @param type - The type of change the current range represents
      * @param commits - The list of commits for this version
      * @param changed - True if the version has changed, false otherwise
+     * @param isTagged - True if the current commit is a version-tagged commit
      */
-    constructor(major, minor, patch, increment, type, commits, changed) {
+    constructor(major, minor, patch, increment, type, commits, changed, isTagged) {
         this.major = major;
         this.minor = minor;
         this.patch = patch;
@@ -24,6 +25,7 @@ class VersionInformation {
         this.type = type;
         this.commits = commits;
         this.changed = changed;
+        this.isTagged = isTagged;
     }
 }
 exports.VersionInformation = VersionInformation;

lib/providers/VersionType.js

@@ -5,11 +5,11 @@ exports.VersionType = void 0;
 var VersionType;
 (function (VersionType) {
     /** Indicates a major version change */
-    VersionType[VersionType["Major"] = 0] = "Major";
+    VersionType["Major"] = "Major";
     /** Indicates a minor version change */
-    VersionType[VersionType["Minor"] = 1] = "Minor";
+    VersionType["Minor"] = "Minor";
     /** Indicates a patch version change */
-    VersionType[VersionType["Patch"] = 2] = "Patch";
+    VersionType["Patch"] = "Patch";
     /** Indicates no change--generally this means that the current commit is already tagged with a version */
-    VersionType[VersionType["None"] = 3] = "None";
-})(VersionType = exports.VersionType || (exports.VersionType = {}));
+    VersionType["None"] = "None";
+})(VersionType || (exports.VersionType = VersionType = {}));

package.json

@@ -5,11 +5,11 @@
   "main": "lib/main.js",
   "scripts": {
     "build": "tsc",
-    "format": "prettier --write '**/*.ts'",
-    "format-check": "prettier --check '**/*.ts'",
+    "format": "prettier --write **/**.ts",
+    "format-check": "prettier --check **/**.ts",
     "lint": "eslint src/**/*.ts",
     "package": "ncc build --source-map --license licenses.txt",
-    "test": "jest --config ./jest.config.js",
+    "test": "jest --runInBand --config ./jest.config.js",
     "all": "npm run build && npm run format && npm run lint && npm run package && npm test"
   },
   "repository": {
@@ -28,20 +28,20 @@
   },
   "homepage": "https://github.com/paulhatch/semantic-version#readme",
   "dependencies": {
-    "@actions/core": "^1.6.0",
+    "@actions/core": "^1.10.1",
     "@actions/exec": "^1.1.1"
   },
   "devDependencies": {
-    "@types/node": "^16.11.7",
-    "@typescript-eslint/parser": "^5.17.0",
-    "@vercel/ncc": "^0.33.3",
-    "eslint": "^8.12.0",
-    "eslint-plugin-github": "^4.3.6",
-    "eslint-plugin-jest": "^26.1.3",
-    "jest": "^27.5.1",
+    "@types/node": "^20.11.13",
+    "@typescript-eslint/parser": "^6.20.0",
+    "@vercel/ncc": "^0.38.1",
+    "eslint": "^8.56.0",
+    "eslint-plugin-github": "^4.10.1",
+    "eslint-plugin-jest": "^27.6.3",
+    "jest": "^29.7.0",
     "js-yaml": "^4.1.0",
-    "prettier": "^2.6.1",
-    "ts-jest": "^27.1.4",
-    "typescript": "^4.6.3"
+    "prettier": "^3.2.4",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
   }
 }

readme.md

@@ -1,12 +1,6 @@
 ![Build](https://github.com/PaulHatch/semantic-version/workflows/Build/badge.svg)
 
-> *Version 5-alpha now available!*
-> Version 5 adds support for several new features and allows easier extension/customization.
-> ##### Breaking Changes
-> - Versions now use the version number (`--sort=-v:*refname`) rather than date to determine which tag is the latest.
-> - "Short tag" support removed
->
-> See the [release notes](https://github.com/PaulHatch/semantic-version/releases/tag/v5.0.0-alpha) for more information.
+See the [configuration guide](guide.md) for help getting started, selecting a versioning strategy and example configurations, or [contributing.md](contributing.md) for information on how to get help or contribute to this project.
 
 # Git-Based Semantic Versioning
 
@@ -19,8 +13,9 @@ automatically while publishing version that only increment by one value per
 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. Including the term `(MAJOR)` or `(MINOR)` in the commit
-message alters the type of change the next version will represent.
+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.
 
 # Background
 
@@ -45,7 +40,7 @@ To solve this problem, this action calculates the next _implied_ version based o
 the most recently tagged version and the commit messages. An additional value called
 the "increment" tracks the count of commits since the last version change, allowing
 a label to be created to mark pre-release versions. The version produced by this
-action is always the_implied version (unless `bump_each_commit` is set to `true`).
+action is always the implied version (unless `bump_each_commit` is set to `true`).
 Subsequently tagging a commit that is chosen as the implied version is what bumps
 the version for future commits.
 
@@ -56,7 +51,8 @@ _Unless the current commit is already tagged, the version produced by this actio
 ## Major and Minor Versions
 
 The commit messages for the span of commits from the last tag are checked for the
-presence of the designated terms (`(MAJOR)` or `(MINOR)` by default), if a term
+presence of version bump patterns. By default, `feat:` triggers a minor version bump,
+while `!:` (e.g., `feat!:`, `fix!:`) or `BREAKING CHANGE:` triggers a major version bump. If a pattern
 is encountered that commit is treated as the start of a major or minor version
 instead of the default patch level. As with normal commits the implied version
 will only increment by one value since the last tag regardless of how many major
@@ -79,17 +75,21 @@ it will be given the new version if the build were to be retriggered, for exampl
 <!-- start usage -->
 
 ```yaml
-- uses: paulhatch/semantic-version@v4.0.2
+- uses: paulhatch/semantic-version@v5.4.0
   with:
     # The prefix to use to identify tags
     tag_prefix: "v"
     # A string which, if present in a git commit, indicates that a change represents a
     # major (breaking) change, supports regular expressions wrapped with '/'
-    major_pattern: "(MAJOR)"
+    major_pattern: "/!:|BREAKING CHANGE:/"
+    # 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: "(MINOR)"
+    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
-    format: "${major}.${minor}.${patch}-prerelease${increment}"
+    version_format: "${major}.${minor}.${patch}-prerelease${increment}"
     # Optional path to check for changes. If any changes are detected in the path the
     # 'changed' output will true. Enter multiple paths separated by spaces.
     change_path: "src/my-service"
@@ -97,20 +97,35 @@ it will be given the new version if the build were to be retriggered, for exampl
     namespace: my-service
     # If this is set to true, *every* commit will be treated as a new version.
     bump_each_commit: false
+    # If bump_each_commit is also set to true, setting this value will cause the version to increment only if the pattern specified is matched.
+    bump_each_commit_patch_pattern: ""
     # If true, the body of commits will also be searched for major/minor patterns to determine the version type.
     search_commit_body: false
     # The output method used to generate list of users, 'csv' or 'json'.
     user_format_type: "csv"
+    # Prevents pre-v1.0.0 version from automatically incrementing the major version.
+    # If enabled, when the major version is 0, major releases will be treated as minor and minor as patch. Note that the version_type output is unchanged.
+    enable_prerelease_mode: true
+    # If enabled, diagnostic information will be added to the action output.
+    debug: false
+    # If true, the branch will be used to select the maximum version.
+    version_from_branch: false
 ```
 
 ## Outputs 
 
 - *major*, *minor*, and *patch* provide the version numbers that have been determined for this commit
 - *increment* is an additional value indicating the number of commits for the current version, starting at zero. This can be used as part of a pre-release label. 
+- *version_type* is the type of version change the new version represents, e.g. `major`, `minor`, `patch`, or `none`.
 - *version* is a formatted version string created using the format input. This is a convenience value to provide a preformatted representation of the data generated by this action.
 - *version_tag* is a string identifier that would be used to tag the current commit as the "released" version. Typically this would only be used to generate a Git tag name.
 - *changed* indicates whether there was a change since the last version if change_path was specified. If no `change_path` was specified this value will always be true since the entire repo is considered. (It is possible to create a commit with no changes, but the Git cli rejects this by default and this case is not considered here)
+- *is_tagged* indicates whether the current commit has a tag matching `tag_prefix`
 - *authors* is a list of authors that have committed to this version, formatted as either csv or json.
+- *current_commit* is the current commit hash.
+- *previous_commit* is the previous commit hash.
+- *previous_version* is the previous version.
+- *debug_output* will show diagnostic information, if debug is enabled
 
 There are two types of "version" string, one is the semantic version output that can be used to identify a build and can include prerelease data and metadata specific to the commit such as `v2.0.1-pre001+cf6e75` (you would produce this string yourself using the version information from this action plus whatever metadata you wanted to add), the other is the tag version string, which identifies a specific commit as being a specific version.
 
@@ -143,12 +158,12 @@ like `v1.2.3+0-db` could be configured like this:
 ```yaml
 - name: Application Version
   id: version
-  uses: paulhatch/semantic-version@v4.0.2
+  uses: paulhatch/semantic-version@v5.4.0
   with:
     change_path: "src/service"
 - name: Database Version
   id: db-version
-  uses: paulhatch/semantic-version@v4.0.2
+  uses: paulhatch/semantic-version@v5.4.0
   with:
     major_pattern: "(MAJOR-DB)"
     minor_pattern: "(MINOR-DB)"
@@ -163,7 +178,7 @@ This history is required to determine the version correctly. To include the hist
 and tags, specify the fetch-depth parameter in your checkout action declaration. Specify
 zero to pull the full history and tags.
 
-```
+```yaml
   - name: Checkout
     uses: actions/checkout@v2
     with:

src/ActionConfig.ts

@@ -4,10 +4,18 @@ export class ActionConfig {
     public branch: string = "HEAD";
     /** The prefix to use to identify tags */
     public tagPrefix: string = "v";
+    /** (Deprecated) Use branches instead of tags */
+    public useBranches: boolean = false;
+    /** If true, the branch will be used to select the maximum version. */
+    public versionFromBranch: string | boolean = false;
     /** A string which, if present in a git commit, indicates that a change represents a major (breaking) change. Wrap with '/' to match using a regular expression. */
-    public majorPattern: string = "(MAJOR)";
+    public majorPattern: string = "/!:|BREAKING CHANGE:/";
+    /** 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 = "(MINOR)";
+    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 */
     public versionFormat: string = '${major}.${minor}.${patch}';
     /** Path to check for changes. If any changes are detected in the path the 'changed' output will true. Enter multiple paths separated by spaces. */
@@ -20,4 +28,12 @@ export class ActionConfig {
     public searchCommitBody: boolean = false;
     /** The output method used to generate list of users, 'csv' or 'json'. Default is 'csv'. */
     public userFormatType: string = "csv";
+    /** Prevents pre-v1.0.0 version from automatically incrementing the major version. If enabled, when the major version is 0, major releases will be treated as minor and minor as patch. Note that the versionType output is unchanged.  */
+    public enablePrereleaseMode: boolean = false;
+    /** If bump_each_commit is also set to true, setting this value will cause the version to increment only if the pattern specified is matched. */
+    public bumpEachCommitPatchPattern: string = "";
+    /** If enabled, diagnostic information will be added to the action output. */
+    public debug: boolean = false;
+    /** Diagnostics to replay */
+    public replay: string = '';
 }

src/CommandRunner.ts

@@ -1,8 +1,15 @@
 // Using require instead of import to support integration testing
 import * as exec from '@actions/exec';
-import * as core from '@actions/core';
+import { DebugManager } from './DebugManager';
 
 export const cmd = async (command: string, ...args: any): Promise<string> => {
+
+    const debugManager = DebugManager.getInstance();
+
+    if (debugManager.isReplayMode()) {
+        return debugManager.replayCommand(command, args);
+    }
+
     let output = '', errors = '';
     const options = {
         silent: true,
@@ -14,15 +21,14 @@ export const cmd = async (command: string, ...args: any): Promise<string> => {
         }
     };
 
+    let caughtError: any = null;
     try {
         await exec.exec(command, args, options);
     } catch (err) {
-        //core.info(`The command cd '${command} ${args.join(' ')}' failed: ${err}`);
+        caughtError = err;
     }
 
-    if (errors !== '') {
-        //core.info(`stderr: ${errors}`);
-    }
+    debugManager.recordCommand(command, args, output, errors, caughtError);
 
     return output;
 };

src/ConfigurationProvider.ts

@@ -1,4 +1,5 @@
 import { CsvUserFormatter } from './formatting/CsvUserFormatter'
+import { BranchVersioningTagFormatter } from './formatting/BranchVersioningTagFormatter'
 import { DefaultTagFormatter } from './formatting/DefaultTagFormatter'
 import { DefaultVersionFormatter } from './formatting/DefaultVersionFormatter'
 import { JsonUserFormatter } from './formatting/JsonUserFormatter'
@@ -11,22 +12,24 @@ import { DefaultCommitsProvider } from './providers/DefaultCommitsProvider'
 import { DefaultCurrentCommitResolver } from './providers/DefaultCurrentCommitResolver'
 import { DefaultVersionClassifier } from './providers/DefaultVersionClassifier'
 import { LastReleaseResolver } from './providers/LastReleaseResolver'
-import { TagLastReleaseResolver } from './providers/TagLastReleaseResolver'
+import { DefaultLastReleaseResolver } from './providers/DefaultLastReleaseResolver'
 import { VersionClassifier } from './providers/VersionClassifier'
 import { BumpAlwaysVersionClassifier } from './providers/BumpAlwaysVersionClassifier'
 import { ActionConfig } from './ActionConfig';
+import { DebugManager } from './DebugManager';
 
 export class ConfigurationProvider {
 
   constructor(config: ActionConfig) {
     this.config = config;
+    DebugManager.getInstance().initializeConfig(config);
   }
 
   private config: ActionConfig;
 
   public GetCurrentCommitResolver(): CurrentCommitResolver { return new DefaultCurrentCommitResolver(this.config); }
 
-  public GetLastReleaseResolver(): LastReleaseResolver { return new TagLastReleaseResolver(this.config); }
+  public GetLastReleaseResolver(): LastReleaseResolver { return new DefaultLastReleaseResolver(this.config); }
 
   public GetCommitsProvider(): CommitsProvider { return new DefaultCommitsProvider(this.config); }
 
@@ -39,7 +42,12 @@ export class ConfigurationProvider {
 
   public GetVersionFormatter(): VersionFormatter { return new DefaultVersionFormatter(this.config); }
 
-  public GetTagFormatter(): TagFormatter { return new DefaultTagFormatter(this.config); }
+  public GetTagFormatter(branchName: string): TagFormatter {
+    if (this.config.versionFromBranch) {
+      return new BranchVersioningTagFormatter(this.config, branchName);
+    }
+    return new DefaultTagFormatter(this.config);
+  }
 
   public GetUserFormatter(): UserFormatter {
     switch (this.config.userFormatType) {

src/DebugManager.ts

@@ -0,0 +1,115 @@
+import { ActionConfig } from "./ActionConfig";
+
+
+/** Utility class for managing debug mode and diagnostic information */
+export class DebugManager {
+    private constructor() { }
+
+    private static instance: DebugManager;
+    /** Returns the singleton instance of the DebugManager */
+    public static getInstance(): DebugManager {
+        if (!DebugManager.instance) {
+            DebugManager.instance = new DebugManager();
+        }
+        return DebugManager.instance;
+    }
+
+    /** Clears the singleton instance of the DebugManager (used for testing) */
+    public static clearState() {
+        DebugManager.instance = new DebugManager();
+    }
+
+
+    private debugEnabled: boolean = false;
+    private replayMode: boolean = false;
+    private diagnosticInfo: DiagnosticInfo | null = null;
+
+    /** Returns true if debug mode is enabled */
+    public isDebugEnabled(): boolean {
+        return this.debugEnabled;
+    }
+
+    /** Returns true if replay mode is enabled */
+    public isReplayMode(): boolean {
+        return this.replayMode;
+    }
+
+    initializeConfig(config: ActionConfig) {
+        if (config.debug) {
+            this.setDebugEnabled(true);
+        } else if (config.replay.length > 0) {
+            this.replayFromDiagnostics(config.replay);
+        }
+    }
+
+
+    /** Enables or disables debug mode, also clears any existing diagnostics info */
+    public setDebugEnabled(enableDebug: boolean = true): void {
+        this.debugEnabled = enableDebug;
+        this.replayMode = false;
+        this.diagnosticInfo = new DiagnosticInfo();
+    };
+
+    /** Enables replay mode and loads the diagnostic information from the specified string */
+    public replayFromDiagnostics(diagnostics: string): void {
+        this.debugEnabled = false
+        this.replayMode = true;
+        this.diagnosticInfo = JSON.parse(diagnostics);
+    }
+
+    /** Returns a JSON string containing the diagnostic information for this run */
+    public getDebugOutput(emptyRepo: boolean = false): string {
+        return this.isDebugEnabled() ? JSON.stringify(this.diagnosticInfo) : '';
+    }
+
+    /** Records a command and its output for diagnostic purposes */
+    public recordCommand(command: string, args: any[], output: string, stderr: string, error: any): void {
+        if (this.isDebugEnabled()) {
+            this.diagnosticInfo?.recordCommand(command, args, output, stderr, error);
+        }
+    }
+
+    /** Replays the specified command and returns the output */
+    public replayCommand(command: string, args: any[]): string {
+        if (this.diagnosticInfo === null) {
+            throw new Error('No diagnostic information available for replay');
+        }
+
+        const commandResult = this.diagnosticInfo.commands.find(c => c.command === command && JSON.stringify(c.args) === JSON.stringify(args));
+        if (!commandResult) {
+            throw new Error(`No result found in diagnostic for command "${command}"`);
+        }
+        if (commandResult.error) {
+            throw commandResult.error;
+        }
+        if (commandResult.stderr) {
+            console.error(commandResult.stderr);
+        }
+        return commandResult.output;
+    }
+}
+
+/** Represents a CLI command result */
+class CommandResult {
+    public command: string;
+    public args: any[];
+    public output: string;
+    public stderr: string;
+    public error: any;
+    public constructor(command: string, args: any[], output: string, stderr: string, error: any) {
+        this.command = command;
+        this.args = args;
+        this.output = output;
+        this.stderr = stderr;
+        this.error = error;
+    }
+}
+
+/** Represents the result of the commands executed for a run */
+class DiagnosticInfo {
+    public commands: CommandResult[] = [];
+    public empty: boolean = false;
+    public recordCommand(command: string, args: any[], output: string, stderr: string, error: any): void {
+        this.commands.push(new CommandResult(command, args, output, stderr, error));
+    }
+}

src/VersionResult.ts

@@ -1,4 +1,5 @@
 import { UserInfo } from "./providers/UserInfo";
+import { VersionType } from "./providers/VersionType";
 
 /** Represents the total output for the action */
 export class VersionResult {
@@ -8,24 +9,30 @@ export class VersionResult {
    * @param minor - The minor version number
    * @param patch - The patch version number
    * @param increment - The number of commits for this version (usually used to create version suffix)
+   * @param versionType - The type of version, e.g. major, minor, patch
    * @param formattedVersion - The formatted semantic version
    * @param versionTag - The string to be used as a Git tag
    * @param changed - True if the version was changed, otherwise false
+   * @param isTagged - True if the commit had a tag that matched the `versionTag` format
    * @param authors - Authors formatted according to the format mode (e.g. JSON, CSV, YAML, etc.)
    * @param currentCommit - The current commit hash 
    * @param previousCommit - The previous commit hash
-   * @param previousVersion - the previous version
+   * @param previousVersion - The previous version
+   * @param debugOutput - Diagnostic information, if debug is enabled
    */
   constructor(
     public major: number,
     public minor: number,
     public patch: number,
     public increment: number,
+    public versionType: VersionType,
     public formattedVersion: string,
     public versionTag: string,
     public changed: boolean,
+    public isTagged: boolean,
     public authors: string,
     public currentCommit: string,
     public previousCommit: string,
-    public previousVersion: string) { }
+    public previousVersion: string,
+    public debugOutput: string) { }
 }

src/action.ts

@@ -3,6 +3,7 @@ import { VersionResult } from './VersionResult';
 import { VersionType } from './providers/VersionType';
 import { UserInfo } from './providers/UserInfo';
 import { VersionInformation } from './providers/VersionInformation';
+import { DebugManager } from './DebugManager';
 
 export async function runAction(configurationProvider: ConfigurationProvider): Promise<VersionResult> {
 
@@ -11,36 +12,43 @@ export async function runAction(configurationProvider: ConfigurationProvider): P
   const commitsProvider = configurationProvider.GetCommitsProvider();
   const versionClassifier = configurationProvider.GetVersionClassifier();
   const versionFormatter = configurationProvider.GetVersionFormatter();
-  const tagFormmater = configurationProvider.GetTagFormatter();
+  const tagFormatter = configurationProvider.GetTagFormatter(await currentCommitResolver.ResolveBranchNameAsync());
   const userFormatter = configurationProvider.GetUserFormatter();
 
+  const debugManager = DebugManager.getInstance();
+
   if (await currentCommitResolver.IsEmptyRepoAsync()) {
-    let versionInfo = new VersionInformation(0, 0, 0, 0, VersionType.None, [], false);
+
+    const versionInfo = new VersionInformation(0, 0, 0, 0, VersionType.None, [], false, false);
     return new VersionResult(
       versionInfo.major,
       versionInfo.minor,
       versionInfo.patch,
       versionInfo.increment,
+      versionInfo.type,
       versionFormatter.Format(versionInfo),
-      tagFormmater.Format(versionInfo),
+      tagFormatter.Format(versionInfo),
       versionInfo.changed,
+      versionInfo.isTagged,
       userFormatter.Format('author', []),
       '',
       '',
-      '0.0.0'
+      tagFormatter.Parse(tagFormatter.Format(versionInfo)).join('.'),
+      debugManager.getDebugOutput(true)
     );
   }
 
   const currentCommit = await currentCommitResolver.ResolveAsync();
-  const lastRelease = await lastReleaseResolver.ResolveAsync(currentCommit, tagFormmater);
+  const lastRelease = await lastReleaseResolver.ResolveAsync(currentCommit, tagFormatter);
   const commitSet = await commitsProvider.GetCommitsAsync(lastRelease.hash, currentCommit);
   const classification = await versionClassifier.ClassifyAsync(lastRelease, commitSet);
 
+  const { isTagged } = lastRelease;
   const { major, minor, patch, increment, type, changed } = classification;
 
   // At this point all necessary data has been pulled from the database, create
   // version information to be used by the formatters
-  let versionInfo = new VersionInformation(major, minor, patch, increment, type, commitSet.commits, changed);
+  let versionInfo = new VersionInformation(major, minor, patch, increment, type, commitSet.commits, changed, isTagged);
 
   // Group all the authors together, count the number of commits per author
   const allAuthors = versionInfo.commits
@@ -60,12 +68,15 @@ export async function runAction(configurationProvider: ConfigurationProvider): P
     versionInfo.minor,
     versionInfo.patch,
     versionInfo.increment,
+    versionInfo.type,
     versionFormatter.Format(versionInfo),
-    tagFormmater.Format(versionInfo),
+    tagFormatter.Format(versionInfo),
     versionInfo.changed,
+    versionInfo.isTagged,
     userFormatter.Format('author', authors),
     currentCommit,
     lastRelease.hash,
-    `${lastRelease.major}.${lastRelease.minor}.${lastRelease.patch}`
+    `${lastRelease.major}.${lastRelease.minor}.${lastRelease.patch}`,
+    debugManager.getDebugOutput()
   );
 }

src/formatting/BranchVersioningTagFormatter.ts

@@ -0,0 +1,104 @@
+
+import { ActionConfig } from '../ActionConfig';
+import { DefaultTagFormatter } from './DefaultTagFormatter';
+
+/** Default tag formatter which allows a prefix to be specified */
+export class BranchVersioningTagFormatter extends DefaultTagFormatter {
+
+    private onVersionBranch: boolean;
+    private major: number;
+    private minor?: number;
+
+    private getRegex(pattern: string) {
+        if (/^\/.+\/[i]*$/.test(pattern)) {
+            const regexEnd = pattern.lastIndexOf('/');
+            const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
+            return new RegExp(pattern.slice(1, regexEnd), parsedFlags);
+        }
+        return new RegExp(pattern);
+    }
+
+    constructor(config: ActionConfig, branchName: string) {
+        super(config);
+        const pattern = config.versionFromBranch === true ?
+            new RegExp("[0-9]+.[0-9]+$|[0-9]+$") :
+            this.getRegex(config.versionFromBranch as string);
+        const result = pattern.exec(branchName);
+
+        if (result === null) {
+            this.major = NaN;
+            this.onVersionBranch = false;
+            return;
+        }
+
+        let branchVersion: string;
+        switch (result?.length) {
+            case 1:
+                branchVersion = result[0];
+                break;
+            case 2:
+                branchVersion = result[1];
+                break;
+            default:
+                throw new Error(`Unable to parse version from branch named '${branchName}' using pattern '${pattern}'`);
+        }
+
+        this.onVersionBranch = true;
+
+        const versionValues = branchVersion.split('.');
+        if (versionValues.length > 2) {
+            throw new Error(`The version string '${branchVersion}' parsed from branch '${branchName}' is invalid. It must be in the format 'major.minor' or 'major'`);
+        }
+        this.major = parseInt(versionValues[0]);
+        if (isNaN(this.major)) {
+            throw new Error(`The major version '${versionValues[0]}' parsed from branch '${branchName}' is invalid. It must be a number.`);
+        }
+        if (versionValues.length > 1) {
+            this.minor = parseInt(versionValues[1]);
+            if (isNaN(this.minor)) {
+                throw new Error(`The minor version '${versionValues[1]}' parsed from branch '${branchName}' is invalid. It must be a number.`);
+            }
+        }
+    }
+
+    public override GetPattern(): string {
+        let pattern = super.GetPattern();
+        if (!this.onVersionBranch) {
+            return pattern;
+        }
+
+        if(this.minor === undefined) {
+            return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.*[0-9].*[0-9]`);
+        }
+
+        return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.${this.minor}.*[0-9]`);
+    }
+
+    override IsValid(tag: string): boolean {
+        if (!this.onVersionBranch) {
+            return super.IsValid(tag);
+        }
+
+        if (!super.IsValid(tag)) {
+            return false;
+        }
+
+        const parsed = super.Parse(tag);
+        if (parsed[0] !== this.major) {
+            return false;
+        }
+        if (this.minor !== undefined && parsed[1] !== this.minor) {
+            return false;
+        }
+        return true;
+    }
+
+    override Parse(tag: string): [major: number, minor: number, patch: number] {
+        if (!this.onVersionBranch) {
+            return super.Parse(tag);
+        }
+
+        const parsed = super.Parse(tag);
+        return [this.major, this.minor || parsed[1], parsed[2]];
+    }
+}

src/formatting/DefaultTagFormatter.ts

@@ -13,7 +13,7 @@ export class DefaultTagFormatter implements TagFormatter {
     this.namespace = config.namespace;
     this.tagPrefix = config.tagPrefix;
     this.namespaceSeperator = '-'; // maybe make configurable in the future
-  } 
+  }
 
   public Format(versionInfo: VersionInformation): string {
     const result = `${this.tagPrefix}${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`;
@@ -35,17 +35,20 @@ export class DefaultTagFormatter implements TagFormatter {
   }
 
   public Parse(tag: string): [major: number, minor: number, patch: number] {
-    let stripedTag;
-    if (this.tagPrefix.includes('/') && tag.includes(this.tagPrefix)) {
-      let tagParts = tag
-        .replace(this.tagPrefix, '<--!PREFIX!-->')
-        .split('/');
-      stripedTag = tagParts[tagParts.length - 1]
-        .replace('<--!PREFIX!-->', this.tagPrefix);
-    } else {
-      let tagParts = tag.split('/');
-      stripedTag = tagParts[tagParts.length - 1];
+
+    if(tag === '') {
+      return [0, 0, 0];
     }
+
+    let tagParts = tag
+      .replace(this.tagPrefix, '<--!PREFIX!-->')
+      .replace(this.namespace, '<--!NAMESPACE!-->')
+      .split('/');
+
+    const stripedTag = tagParts[tagParts.length - 1]
+      .replace('<--!PREFIX!-->', this.tagPrefix)
+      .replace('<--!NAMESPACE!-->', this.namespace);
+
     let versionValues = stripedTag
       .substring(this.tagPrefix.length)
       .slice(0, this.namespace === '' ? 999 : -(this.namespace.length + 1))
@@ -62,4 +65,16 @@ export class DefaultTagFormatter implements TagFormatter {
     return [major, minor, patch];
   };
 
+  public IsValid(tag: string): boolean {
+    const regexEscape = (literal: string) => literal.replace(/\W/g, '\\$&');
+    const tagPrefix = regexEscape(this.tagPrefix);
+    const namespaceSeperator = regexEscape(this.namespaceSeperator);
+    const namespace = regexEscape(this.namespace);
+
+    if (!!this.namespace) {
+      return new RegExp(`^${tagPrefix}[0-9]+\.[0-9]+\.[0-9]+${namespaceSeperator}${namespace}$`).test(tag);
+    }
+
+    return new RegExp(`^${tagPrefix}[0-9]+\.[0-9]+\.[0-9]+$`).test(tag);
+  }
 }

src/formatting/TagFormatter.ts

@@ -4,4 +4,5 @@ export interface TagFormatter {
   Format(versionInfo: VersionInformation): string;
   GetPattern(): string;
   Parse(tag: string): [major: number, minor: number, patch: number];
+  IsValid(tag: string): boolean;
 }

src/main.ts

@@ -3,9 +3,10 @@ import { ActionConfig } from './ActionConfig';
 import { ConfigurationProvider } from './ConfigurationProvider';
 import { VersionResult } from './VersionResult';
 import * as core from '@actions/core';
+import { VersionType } from './providers/VersionType';
 
 function setOutput(versionResult: VersionResult) {
-  const { major, minor, patch, increment, formattedVersion, versionTag, changed, authors, currentCommit, previousCommit, previousVersion } = versionResult;
+  const { major, minor, patch, increment, versionType, formattedVersion, versionTag, changed, isTagged, authors, currentCommit, previousCommit, previousVersion, debugOutput } = versionResult;
 
   const repository = process.env.GITHUB_REPOSITORY;
 
@@ -23,29 +24,63 @@ function setOutput(versionResult: VersionResult) {
   core.setOutput("minor", minor.toString());
   core.setOutput("patch", patch.toString());
   core.setOutput("increment", increment.toString());
+  core.setOutput("version_type", VersionType[versionType].toLowerCase());
   core.setOutput("changed", changed.toString());
+  core.setOutput("is_tagged", isTagged.toString());
   core.setOutput("version_tag", versionTag);
   core.setOutput("authors", authors);
-  core.setOutput("lastVersion", authors);
   core.setOutput("previous_commit", previousCommit);
   core.setOutput("previous_version", previousVersion);
+  core.setOutput("current_commit", currentCommit);
+  core.setOutput("debug_output", debugOutput);
 }
 
 export async function run() {
 
+  function toBool(value: string): boolean {
+    if (!value || value.toLowerCase() === 'false') {
+      return false;
+    } else if (value.toLowerCase() === 'true') {
+      return true;
+    }
+    return false;
+  }
+  
+  function toStringOrBool(value: string): string | boolean {
+    if (!value || value === 'false') {
+      return false;
+    }
+    if (value === 'true') {
+      return true;
+    }
+    return value;
+  }  
+
   const config: ActionConfig = {
     branch: core.getInput('branch'),
     tagPrefix: core.getInput('tag_prefix'),
+    useBranches: toBool(core.getInput('use_branches')),
+    versionFromBranch: toStringOrBool(core.getInput('version_from_branch')),
     majorPattern: core.getInput('major_pattern'),
     minorPattern: core.getInput('minor_pattern'),
+    majorFlags: core.getInput('major_regexp_flags'),
+    minorFlags: core.getInput('minor_regexp_flags'),
     versionFormat: core.getInput('version_format'),
     changePath: core.getInput('change_path'),
     namespace: core.getInput('namespace'),
-    bumpEachCommit: core.getInput('bump_each_commit') === 'true',
-    searchCommitBody: core.getInput('search_commit_body') === 'true',
-    userFormatType: core.getInput('user_format_type')
+    bumpEachCommit: toBool(core.getInput('bump_each_commit')),
+    searchCommitBody: toBool(core.getInput('search_commit_body')),
+    userFormatType: core.getInput('user_format_type'),
+    enablePrereleaseMode: toBool(core.getInput('enable_prerelease_mode')),
+    bumpEachCommitPatchPattern: core.getInput('bump_each_commit_patch_pattern'),
+    debug: toBool(core.getInput('debug')),
+    replay: ''
   };
 
+  if (config.useBranches) {
+    core.warning(`The 'use_branches' input option is deprecated, please see the documentation for more information on how to use branches`);
+  }
+
   if (config.versionFormat === '' && core.getInput('format') !== '') {
     core.warning(`The 'format' input is deprecated, use 'versionFormat' instead`);
     config.versionFormat = core.getInput('format');

src/providers/BumpAlwaysVersionClassifier.ts

@@ -8,9 +8,16 @@ import { VersionType } from "./VersionType";
 
 export class BumpAlwaysVersionClassifier extends DefaultVersionClassifier {
 
+    protected patchPattern: (commit: CommitInfo) => boolean;
+    protected enablePrereleaseMode: boolean;
+
     constructor(config: ActionConfig) {
         super(config);
-        // Placeholder for consistency
+
+        this.enablePrereleaseMode = config.enablePrereleaseMode;
+        this.patchPattern = !config.bumpEachCommitPatchPattern ?
+            _ => true :
+            this.parsePattern(config.bumpEachCommitPatchPattern, "", config.searchCommitBody);
     }
 
     public override async ClassifyAsync(lastRelease: ReleaseInformation, commitSet: CommitInfoSet): Promise<VersionClassification> {
@@ -21,27 +28,66 @@ export class BumpAlwaysVersionClassifier extends DefaultVersionClassifier {
 
         let { major, minor, patch } = lastRelease;
         let type = VersionType.None;
+        let increment = 0;
 
         if (commitSet.commits.length === 0) {
             return new VersionClassification(type, 0, false, major, minor, patch);
         }
 
         for (let commit of commitSet.commits.reverse()) {
+
             if (this.majorPattern(commit)) {
-                major += 1;
-                minor = 0;
-                patch = 0;
                 type = VersionType.Major;
             } else if (this.minorPattern(commit)) {
-                minor += 1;
-                patch = 0;
                 type = VersionType.Minor;
-            } else {
-                patch += 1;
+            } else if (this.patchPattern(commit) ||
+                (major === 0 && minor === 0 && patch === 0 && commitSet.commits.length > 0)) {
                 type = VersionType.Patch;
+            } else {
+                type = VersionType.None;
             }
+
+
+            if (this.enablePrereleaseMode && major === 0) {
+                switch (type) {
+                    case VersionType.Major:
+                    case VersionType.Minor:
+                        minor += 1;
+                        patch = 0;
+                        increment = 0;
+                        break;
+                    case VersionType.Patch:
+                        patch += 1;
+                        increment = 0;
+                        break;
+                    default:
+                        increment++;
+                        break;
+                }
+            } else {
+                switch (type) {
+                    case VersionType.Major:
+                        major += 1;
+                        minor = 0;
+                        patch = 0;
+                        increment = 0;
+                        break;
+                    case VersionType.Minor:
+                        minor += 1;
+                        patch = 0;
+                        break;
+                    case VersionType.Patch:
+                        patch += 1;
+                        increment = 0;
+                        break;
+                    default:
+                        increment++;
+                        break;
+                }
+            }
+
         }
 
-        return new VersionClassification(type, 0, true, major, minor, patch);
+        return new VersionClassification(type, increment, true, major, minor, patch);
     }
 }

src/providers/CurrentCommitResolver.ts

@@ -10,4 +10,10 @@ export interface CurrentCommitResolver {
    * @returns True if the repository is empty
    */
   IsEmptyRepoAsync(): Promise<boolean>;
+
+  /**
+   * Returns the current branch
+   * @returns The current branch
+   */
+  ResolveBranchNameAsync(): Promise<string>;
 }

src/providers/DefaultCurrentCommitResolver.ts

@@ -22,4 +22,12 @@ export class DefaultCurrentCommitResolver implements CurrentCommitResolver {
         let lastCommitAll = (await cmd('git', 'rev-list', '-n1', '--all')).trim();
         return lastCommitAll === '';
     }
+
+    public async ResolveBranchNameAsync(): Promise<string> {
+        const branchName =
+            this.branch == 'HEAD' ? await cmd('git', 'rev-parse', '--abbrev-ref', 'HEAD') : this.branch;
+
+
+        return branchName.trim();
+    }
 }

src/providers/DefaultLastReleaseResolver.ts

@@ -5,12 +5,14 @@ import { ReleaseInformation } from "./ReleaseInformation";
 import { ActionConfig } from "../ActionConfig";
 import * as core from '@actions/core';
 
-export class TagLastReleaseResolver implements LastReleaseResolver {
+export class DefaultLastReleaseResolver implements LastReleaseResolver {
 
     private changePath: string;
+    private useBranches: boolean;
 
     constructor(config: ActionConfig) {
         this.changePath = config.changePath;
+        this.useBranches = config.useBranches;
     }
 
     async ResolveAsync(current: string, tagFormatter: TagFormatter): Promise<ReleaseInformation> {
@@ -19,19 +21,32 @@ export class TagLastReleaseResolver implements LastReleaseResolver {
         let currentTag = (await cmd(
             `git tag --points-at ${current} ${releasePattern}`
         )).trim();
+
+        currentTag = tagFormatter.IsValid(currentTag) ? currentTag : '';
+        const isTagged = currentTag !== '';
+
         const [currentMajor, currentMinor, currentPatch] = !!currentTag ? tagFormatter.Parse(currentTag) : [null, null, null];
 
+        let tagsCount = 0;
+
         let tag = '';
         try {
+            const refPrefixPattern = this.useBranches ? 'refs/heads/' : 'refs/tags/';
             if (!!currentTag) {
                 // If we already have the current branch tagged, we are checking for the previous one
                 // so that we will have an accurate increment (assuming the new tag is the expected one)
-                const command = `git for-each-ref --count=2 --sort=-v:*refname --format=%(refname:short) --merged=${current} refs/tags/${releasePattern}`;
-                tag = await cmd(command);
-                tag = tag.split('\n').at(-1) || '';
+                const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
+                const tags = (await cmd(command)).split('\n')
+                tagsCount = tags.length;
+                tag = tags
+                    .find(t => tagFormatter.IsValid(t) && t !== currentTag) || '';
+
             } else {
-                const command = `git for-each-ref --count=1 --sort=-v:*refname --format=%(refname:short) --merged=${current} refs/tags/${releasePattern}`;
-                tag = await cmd(command);
+                const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
+                const tags = (await cmd(command)).split('\n')
+                tagsCount = tags.length;
+                tag = tags
+                    .find(t => tagFormatter.IsValid(t)) || '';
             }
 
             tag = tag.trim();
@@ -47,16 +62,21 @@ export class TagLastReleaseResolver implements LastReleaseResolver {
                 // practice this isn't likely to happen, but it keeps the test output from being
                 // polluted with a bunch of warnings.
 
-                core.warning('No tags are present for this repository. If this is unexpected, check to ensure that tags have been pulled from the remote.');
+                if (tagsCount > 0) {
+                    core.warning(`None of the ${tagsCount} tags(s) found were valid version tags for the present configuration. If this is unexpected, check to ensure that the configuration is correct and matches the tag format you are using.`);
+                } else {
+                    core.warning('No tags are present for this repository. If this is unexpected, check to ensure that tags have been pulled from the remote.');
+                }
             }
+            const [major, minor, patch] = tagFormatter.Parse('');
             // no release tags yet, use the initial commit as the root
-            return new ReleaseInformation(0, 0, 0, '', currentMajor, currentMinor, currentPatch);
+            return new ReleaseInformation(major, minor, patch, '', currentMajor, currentMinor, currentPatch, isTagged);
         }
 
         // parse the version tag
         const [major, minor, patch] = tagFormatter.Parse(tag);
         const root = await cmd('git', `merge-base`, tag, current);
-        return new ReleaseInformation(major, minor, patch, root.trim(), currentMajor, currentMinor, currentPatch);
+        return new ReleaseInformation(major, minor, patch, root.trim(), currentMajor, currentMinor, currentPatch, isTagged);
     }
 
 }

src/providers/DefaultVersionClassifier.test.ts

@@ -1,3 +1,4 @@
+import { expect, test } from "@jest/globals";
 import { ActionConfig } from "../ActionConfig";
 import { CommitInfo } from "./CommitInfo";
 import { CommitInfoSet } from "./CommitInfoSet";
@@ -8,7 +9,7 @@ test('Regular expressions can be used as minor tag direct', async () => {
 
     const classifier = new DefaultVersionClassifier({ ...new ActionConfig(), ...{ tagPrefix: '', minorPattern: '/S[a-z]+Value/' }});
 
-    const releaseInfo =new ReleaseInformation(0,0,1,"",null,null,null);
+    const releaseInfo =new ReleaseInformation(0,0,1,"",null,null,null,false);
     const commitSet = new CommitInfoSet(false, [
         new CommitInfo("", "Second Commit SomeValue", "", "","", new Date(), "", "", new Date(), []),
         new CommitInfo("", "Initial Commit", "", "","", new Date(), "", "", new Date(), []),

src/providers/DefaultVersionClassifier.ts

@@ -10,16 +10,20 @@ export class DefaultVersionClassifier implements VersionClassifier {
 
     protected majorPattern: (commit: CommitInfo) => boolean;
     protected minorPattern: (commit: CommitInfo) => boolean;
+    protected enablePrereleaseMode: boolean;
 
     constructor(config: ActionConfig) {
         const searchBody = config.searchCommitBody;
-        this.majorPattern = this.parsePattern(config.majorPattern, searchBody);
-        this.minorPattern = this.parsePattern(config.minorPattern, searchBody);
+        this.majorPattern = this.parsePattern(config.majorPattern, config.majorFlags, searchBody);
+        this.minorPattern = this.parsePattern(config.minorPattern, config.minorFlags, searchBody);
+        this.enablePrereleaseMode = config.enablePrereleaseMode;
     }
 
-    protected parsePattern(pattern: string, searchBody: boolean): (pattern: CommitInfo) => boolean {
-        if (pattern.startsWith('/') && pattern.endsWith('/')) {
-            var regex = new RegExp(pattern.slice(1, -1));
+    protected parsePattern(pattern: string, flags: string, searchBody: boolean): (pattern: CommitInfo) => boolean {
+        if (/^\/.+\/[i]*$/.test(pattern)) {
+            const regexEnd = pattern.lastIndexOf('/');
+            const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
+            const regex = new RegExp(pattern.slice(1, regexEnd), parsedFlags || flags);
             return searchBody ?
                 (commit: CommitInfo) => regex.test(commit.subject) || regex.test(commit.body) :
                 (commit: CommitInfo) => regex.test(commit.subject);
@@ -32,7 +36,21 @@ export class DefaultVersionClassifier implements VersionClassifier {
     }
 
     protected getNextVersion(current: ReleaseInformation, type: VersionType): ({ major: number, minor: number, patch: number }) {
-        
+
+        if (this.enablePrereleaseMode && current.major === 0) {
+            switch (type) {
+                case VersionType.Major:
+                    return { major: current.major, minor: current.minor + 1, patch: 0 };
+                case VersionType.Minor:
+                case VersionType.Patch:
+                    return { major: current.major, minor: current.minor, patch: current.patch + 1 };
+                case VersionType.None:
+                    return { major: current.major, minor: current.minor, patch: current.patch };
+                default:
+                    throw new Error(`Unknown change type: ${type}`);
+            }
+        }
+
         switch (type) {
             case VersionType.Major:
                 return { major: current.major + 1, minor: 0, patch: 0 };
@@ -89,8 +107,8 @@ export class DefaultVersionClassifier implements VersionClassifier {
             // - commit 4 - v2.0.1+0
 
             const versionsMatch = lastRelease.currentMajor === major && lastRelease.currentMinor === minor && lastRelease.currentPatch === patch;
-            const currentIncremement = versionsMatch ? increment : 0;
-            return new VersionClassification(VersionType.None, currentIncremement, false, <number>lastRelease.currentMajor, <number>lastRelease.currentMinor, <number>lastRelease.currentPatch);
+            const currentIncrement = versionsMatch ? increment : 0;
+            return new VersionClassification(VersionType.None, currentIncrement, false, <number>lastRelease.currentMajor, <number>lastRelease.currentMinor, <number>lastRelease.currentPatch);
         }
 
 

src/providers/ReleaseInformation.ts

@@ -9,6 +9,7 @@ export class ReleaseInformation {
    * @param currentMajor - the major version number from the current commit
    * @param currentMinor - the minor version number from the current commit
    * @param currentPatch - the patch version number from the current commit
+   * @param isTagged - whether the current commit is tagged with a version
    */
   constructor(
     public major: number,
@@ -17,5 +18,6 @@ export class ReleaseInformation {
     public hash: string,
     public currentMajor: number | null,
     public currentMinor: number | null,
-    public currentPatch: number | null,) { }
+    public currentPatch: number | null,
+    public isTagged: boolean,) { }
 }

src/providers/VersionInformation.ts

@@ -15,6 +15,7 @@ export class VersionInformation {
    * @param type - The type of change the current range represents
    * @param commits - The list of commits for this version
    * @param changed - True if the version has changed, false otherwise
+   * @param isTagged - True if the current commit is a version-tagged commit
    */
   constructor(
     public major: number,
@@ -23,5 +24,6 @@ export class VersionInformation {
     public increment: number,
     public type: VersionType,
     public commits: CommitInfo[],
-    public changed: boolean) { }
+    public changed: boolean,
+    public isTagged: boolean) { }
 }

src/providers/VersionType.ts

@@ -2,11 +2,11 @@
 /** Indicates the type of change a particular version change represents */
 export enum VersionType {
   /** Indicates a major version change */
-  Major,
+  Major = 'Major',
   /** Indicates a minor version change */
-  Minor,
+  Minor = 'Minor',
   /** Indicates a patch version change */
-  Patch,
+  Patch = 'Patch',
   /** Indicates no change--generally this means that the current commit is already tagged with a version */
-  None
+  None = 'None'
 }