Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Major Tag #29

Closed
wants to merge 3 commits into from
Closed

Conversation

bradyclifford
Copy link
Contributor

@bradyclifford bradyclifford commented Feb 6, 2023

Summary of PR changes

Allow the creation of a major tag adjacent to the normal major + minor + patch tag 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 major version.

This a common pattern used by the mainstream GitHub Actions, including those we already use in this repo:
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

  • For major, minor, or breaking changes, at least one of the commit messages contains the appropriate +semver: keywords.
    • See the Incrementing the Version section of the repository's README.md for more details.
  • The action code does not contain sensitive information.

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.

@bradyclifford bradyclifford requested review from a team as code owners February 6, 2023 16:12
@bradyclifford bradyclifford changed the title Output new vars Create Major Tag Feb 6, 2023
@@ -66,3 +67,10 @@ jobs:
else
echo "There were no changes to commit"
fi

- name: Upload dist folder as artifact on commit failure
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This helps with those using forks to manually upload the correct dist changes produced.

@bradyclifford
Copy link
Contributor Author

Due to forking issues, #28 was created instead.

@bradyclifford bradyclifford deleted the patch-2 branch March 3, 2023 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant