Stop naming a release version outside the changelog - #36
Merged
Conversation
Four places named 0.1.0 without pinning anything, and each would have read as stale the moment 0.2.0 shipped. The sample configs are inert: install-samples.sh always installs with --source, so version never resolves anything. They get 0.0.0 and a comment saying why the value is deliberately not kept in step with the tags. The README example and the two examples inside fetch-theme.sh — its header comment and the sample config its error messages print — are documentation a reader copies, so 0.0.0 would be wrong guidance there. They get a <version> placeholder, matching what the release section of the README already does for the same reason. The test fixtures stub gh and never download, so 0.1.0 suggested a dependency on a real release that does not exist. They get 1.2.3, which cannot be read as anything but an arbitrary value. Closes #34
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.
Closes #34.
Four places named
0.1.0without pinning anything. Each would have read as stale the moment0.2.0shipped, and two of them were user-facing.samples/*/docs/theme.toml0.0.0+ commentinstall-samples.shalways installs with--source, soversionnever resolves anythingdocs/theme.tomlexample<version>+ link to releases0.0.0would be wrong guidancescripts/fetch-theme.shheader comment andSAMPLE_CONFIG<version>SAMPLE_CONFIGis what a consumer sees when theirtheme.tomlis malformedtests/{installer,pdf}-test.shfixtures1.2.3ghand copies a local tarball, so0.1.0implied a dependency on a release that the test never fetches<version>matches what the README's "Publishing a New Release" section already uses, for the same stated reason — so the example cannot go stale again.Scope note
The issue described the samples and the README. The two
fetch-theme.shexamples and the test fixtures turned up while checking the issue's own acceptance criterion — that no file outsideCHANGELOG.mdnames a specific release — and are the same defect, so they are fixed here rather than left for a follow-up. Say the word if you would rather see the script and tests split out.No
CHANGELOG.mdentry.fetch-theme.shis release-surface, so this technically changes it, but the change is a placeholder inside a comment and an error message: nothing a consumer's reviewer triages, which is what that file says its sections are for. Happy to add a### scriptsline if you would rather it be recorded.Verification
tests/installer-test.shandtests/pdf-test.shboth pass — the fixture rename is consistent acrosswrite_configdefaults and every assertion that greps the installer's output.shellcheckclean onscripts/*.shandtests/*.sh.--strict;install-samples.sh --forceinstalls and recordsversion = "0.0.0",source = "local"in.meta.markdownlint-cli2passes; README stays within 80 columns.grepfor0.1.0across the tree returns nothing outsideCHANGELOG.md, which is the issue's acceptance criterion.