chore: DX-2271: Note about local tags #930
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a note to the readme warning maintainers not to push local tags and also provides a convenience script to delete local tags that aren't on the remote.
Why the changes
A few times, tags have been manually pushed to this repo, which has broken the version calculation of the "Publish to NPM" workflow.
Things worth calling out
Without this PR, running
.github/scripts/version_up.sh
could end up creating local tags which then get pushed unintentionally.Before submitting the PR, please consider the following:
feat:
,fix:
,chore:
,docs:
, orrefactor:
.