Point new users at the latest release instead of main - #169
Merged
Conversation
The README's first instruction and the website's step 1 both told people to clone the repository, which gives them whatever main happens to hold. main is where Throughstone itself is built, so that is the one place a user should not be sent by default — as the last few days demonstrated. Both now clone the v1.7.1 tag, and say why. The "Use this template" path is flagged as unable to be pinned, since GitHub always copies the default branch. The detached-HEAD notice git prints on a tag clone is called out as expected, because init.sh removes the template's git history in the next step anyway. The website edit is made in brand/site/index.html and published to docs/index.html with brand/publish-site.sh, per tests/site-publish.sh.
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 README's first instruction and the website's step 1 both told people to clone the repository,
which hands them whatever
mainholds at that moment.mainis where Throughstone itself is built,so it is the one place a new user should not be sent by default.
Changes
README.md—git clone --branch v1.7.1 …, with a note on why, a pointer to Releases, and aline explaining that git's detached HEAD notice is expected and harmless (step 2 removes the
template's git history anyway).
README.md— the "Use this template" option is flagged as unable to be pinned to a release,since GitHub always copies the default branch.
brand/site/index.html→ published todocs/index.htmlviabrand/publish-site.sh, sothe website's step 1 matches. (
tests/site-publish.shenforces that the two stay in sync — itcaught an edit made directly to the published copy.)
CHANGELOG.md— one entry, folded into the existing### Changedblock.Verified
git clone --branch v1.7.1 …run end to end: exit 0, lands oncc9d18c,git describereportsv1.7.1,init.shpresent and executable.[Unreleased]has exactly one### Changedand one### Fixedheading.Note
This bumps to a hardcoded tag, so it goes stale unless every release updates it. That step is now
item 6 of the internal release checklist.