docs: Encourage use of v1 instead of master #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Knowing that every pleb will copy-paste this example as-is, I'd recommend encouraging use of v1 (e.g. latest `v1.x.x` tag on this repo), instead of `master`, so that if one day you need to make a significant change to the format somehow or add/change required options, that you will do so in a SemVer compliant way and that it won't break thousands of projects already using the action.
GraemeWatt
added a commit
to HEPData/hepdata
that referenced
this pull request
Mar 2, 2021
* The 'master' branch has been renamed to 'main', but docs recommend use of 'v1' branch instead (see saucelabs/sauce-connect-action#22).
This was referenced Mar 12, 2021
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Knowing that every pleb will copy-paste this example as-is,
I'd recommend encouraging use of v1 (e.g. latest
v1.x.xtag on this repo),instead of
master, so that if one day you need to make a significant changeto the format somehow or add/change required options, that you will do so
in a SemVer compliant way and that it won't break thousands of projects
already using the action.