Documents and automates our versioning and release process. This relies on a few of things:
Using Changesets to handle automatic versioning and changelog generation.
A workflow that automates the process of tagging after a new version is created (more on this below).
Documentation for creating a release in GitHub based on the automated tags.
Automated tagging is modeled after the versioning recommendations outlined in the actions/toolkit. This makes it possible for users to bind their action to different SemVer levels as desired. I've updated our usage examples to recommend binding to a major version (v3) so that most new users will get non-breaking minor and patch updates automatically. Recommending the major version tag also means we'll only have to update the usage examples for new major versions. I'm working on a separate ticket to document the tagging/versioning process for users in case they would rather use something other than the latest major version.
JIRA Ticket
CICD-25
What Are We Doing Here
Documents and automates our versioning and release process. This relies on a few of things:
Automated tagging is modeled after the versioning recommendations outlined in the actions/toolkit. This makes it possible for users to bind their action to different SemVer levels as desired. I've updated our usage examples to recommend binding to a major version (
v3) so that most new users will get non-breaking minor and patch updates automatically. Recommending the major version tag also means we'll only have to update the usage examples for new major versions. I'm working on a separate ticket to document the tagging/versioning process for users in case they would rather use something other than the latest major version.