Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.04 KB

RELEASE.md

File metadata and controls

48 lines (30 loc) · 2.04 KB
Raw

Releases

The Writers' Toolkit repository is a collection of different tools that can have different release mechanisms.

GitHub Actions

The following directories contain GitHub Actions actions:

You release each action by creating or updating Git tags. The Git tag begins with the action directory, then a slash (/), and then the tag version. For example, publish-technical-documentation-release/v1.0.0 is the v1.0.0 release of the publish-technical-documentation-release action.

The actions follow semantic versioning.

To create a tag, use the following command:

git tag --annotate --force --sign --local-user=<GPG KEY ID> -m <MESSAGE> <TAG>

Where:

  • <GPG KEY ID> is the ID of the GPG key associated with your GitHub account.

    For more information refer to Signing commits.

  • <MESSAGE> is a short message explaining the change to the action.

    This is typically similar to a commit title explaining the "what" of the change.

  • TAG is the name of the tag using the previously explained naming convention.

Each release has three tags:

  • Major version: <ACTION>/v<MAJOR>
  • Major and minor version: <ACTION>/v<MAJOR>.<MINOR>
  • Major, minor, and patch version: <ACTION>/v<MAJOR>.<MINOR>.<PATCH>

The major version tag should point to the same commit as the latest major and minor version tag. The major and minor version tag should point to the same commit as the major, minor, and patch version tag.

The --force flag provided to the git tag command overwrites existing tags which you need to be able to move the major version and major and minor version tags when you release a new major, minor, and patch version.