Repository navigation
docs: expand the Customize checklist (src, Actions secrets) - #23
Merged
fabianzimber merged 1 commit intoAug 18, 2026
Merged
fabianzimber merged 1 commit into
fabianzimber merged 1 commit into
Conversation
Customize listed package.json fields and the changeset repo, which is about half of what actually ships with a placeholder in it. Someone following it to the end still has your-org, your-scope, YEAR and TODO in their package. Rewrite it as a grouped checklist covering identity (including LICENSE and the bug-report issue template), the source entrypoints, and publishing. Every item was found by grepping the tree for placeholders, and the secret names were read from .github/workflows/release.yml rather than assumed. Two traps are called out because neither is discoverable from the file you are editing: tests/index.test.ts asserts on the placeholder constant in src/index.ts and fails the moment you delete it, and dropping src/server.ts without also removing the ./server export and the second tsup config object breaks the build. Closes shiftbloom-studio#19
fabianzimber
approved these changes
Aug 18, 2026
fabianzimber
left a comment
Member
There was a problem hiding this comment.
@dchaudhari7177 Much thanks for the contribution 👍 the customization documentation looks really good 💯
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
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 #19. README only.
Method
Rather than adding the three items named in the issue, I grepped the tree for template placeholders so the checklist is exhaustive by construction. Everything that ships containing
your-org,your-scope,YEARorTODO:package.json@your-scope/your-package,TODO: describe your package,your-org/your-repo×3, emptyauthor.changeset/config.jsonchangelog[1].repo→your-org/your-repoLICENSECopyright (c) YEAR YOUR_NAME.github/ISSUE_TEMPLATE/bug_report.md@your-scope/your-packagein the environment blocksrc/index.tsTEMPLATE_PACKAGE_NAMEtests/index.test.tsTEMPLATE_PACKAGE_NAMEThe last two rows were not in the issue and are the ones most likely to bite.
Structure
Three groups — Identity, Your code, Publishing — as checkboxes, ending with a "run the four checks once" line.
Two traps get explicit treatment, because in both cases the thing you must change is not in the file you are looking at:
tests/index.test.tsasserts on the placeholder constant. Replacesrc/index.tsas instructed and the test suite fails, which reads like you broke something.Deleting
src/server.tsis not sufficient.tsup.config.tshas a second config object withentry: { server: "src/server.ts" }andpackage.jsonhas a./serverexport block. I verified this rather than assuming — removing only the file gives:with
dist/containing only theindexoutputs. So the checklist says to remove all three together.The
NPM_TOKEN/NODE_AUTH_TOKENnaming comes from.github/workflows/release.yml(lines 19–20 accept either viasecrets.NPM_TOKEN || secrets.NODE_AUTH_TOKEN), and the deliberate guard at line 50 emitsMissing npm token. Add a repo secret named NPM_TOKEN (or NODE_AUTH_TOKEN) with an npm Automation token.— so the README now matches the message a user will actually see. "Automation token" is quoted from that message rather than invented.Also added
publishConfig.accessandengines.node, since both are decisions a new package should make once and neither was mentioned anywhere.Verification
npm run build,npm run lint,npm test(1 suite, 1 test passing) all green on Node v24.17.0;git diff --checkclean. OnlyREADME.mdis modified — I did not fill in any placeholder, since this is the template repo.