Repository navigation
Keep version numbers out of comments - #217
Merged
Merged
Conversation
A version in a comment drifts the moment the build moves. The fixture and example comments now describe the scenario, and the commands and catalog files carry the numbers. The ImageTag docs snippet that stated its outputs in comments is now four locked examples, so the page shows what the calls return.
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.
A version in a comment drifts the moment the build moves. This removes them.
examples/monorepo/build.sbtdrops the roadmap labels (Gap 1,Gap 2) as well.exampleValues, so the page shows whatforCommit,branchCommit, andslugreturn.Left as is: the
# vX.Y.Zafter a SHA in action pins (zipx parses and emits that annotation from the catalog, so it cannot drift), URLs, and the0.y.0pattern sbt's early-semver rule is stated in.Proof:
sbt "scalafmtAll; cleanFull; testFull"passes, plusplugin/scriptedforcatalog-wins,release-workflow, andmutual-snapshots.