im-open / create-release

An action that creates a GitHub release
MIT License
0 stars 1 forks source link

ITHD-204625: Create Major version tag on merge #15

Closed bradyclifford closed 1 year ago

bradyclifford commented 1 year ago

https://jira.extendhealth.com/servicedesk/customer/portal/26/ITHD-204625

Summary of PR changes

Allow the creation of a major tag adjacent to the normal major + minor + patch release creation.

This allows downstream workflows to reference the major version instead of the specific minor + patch. Doing so will reduce dependabot alerts and unnecessary PRs to get the latest minor version.

This is similar to the same pattern used with GitHub Actions. https://github.com/actions/toolkit/blob/main/docs/action-versioning.md#recommendations

As an example, release v1.2.3 is created with an accompanying v1 tag. Downstream consumers of this repo can reference v1 instead of v1.2.3.

PR Requirements

NOTE: If the repo's workflow could not automatically update the README.md, it should be updated manually with the next version. For javascript actions, if the repo's workflow could not automatically recompile the action it should also be updated manually as part of the PR.