Point every README pin at v0.2.4, and stop hardcoding a SHA that cannot be right - #32
Merged
Conversation
…ot be right The v0.2.4 tag failed at the first release gate: "README pins v0.2.3 but this release is v0.2.4". The gate was correct and nothing was published, so the version number is not spent. Three of the pins were simply stale. The fourth was worse and it was added yesterday: the new pin-to-a-commit section hardcoded a3b2fbc, which is the commit v0.2.3 points at. A SHA printed in the README can never be the commit that ships it, because that commit contains this file, so it would have named the previous release at every release from here on. The section now tells the reader to resolve the tag themselves with git ls-remote and pin what came back, and says why no SHA is printed. That is the advice @fschutt actually gave, which was to pin a commit, not to copy one out of a README.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The v0.2.4 tag failed the first release gate:
README pins v0.2.3 but this release is v0.2.4. Nothing published, so the number is still free.Three pins were stale. The fourth was a flaw introduced in #30: the pin-to-a-commit section hardcoded
a3b2fbc, the commit behind v0.2.3. A SHA printed in the README can never be the commit that ships it, since that commit contains the file naming it, so it would have pointed at the previous release forever.It now tells the reader to run
git ls-remoteand pin what comes back, and says why no SHA is printed. That is what @fschutt actually advised: pin a commit, not copy one out of a README.