guide.md

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.

- 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.

- 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.

- 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.

- uses: paulhatch/semantic-version@latest
  with:
    version_from_branch: true

Alternately, you can override the branch pattern.

- 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.

- id: version
  uses: paulhatch/semantic-version@latest
  with:
    change_path: "src/my-service"
    namespace: my-service
- name: Cancel if Unchanged
  if: ${{ ! 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 sincematches 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 /.
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.