Repository navigation
docs: setup instructions match what a render contains - #22
Merged
Merged
Conversation
The post-generation message pointed at NEW_LIBRARY_CHECKLIST.md, which 7509b31 had moved out of template/, so no render contained it. README.md and .claude/LIBRARY_CREATION.md told the reader to git rm scripts/setup_repo.py and .claude/LIBRARY_CREATION.md from the new library, and neither file is in a render. The checklist's manual publish route pushed a tag and created a GitHub Release, and nothing listens to either. The checklist is rendered again (copier update leaves it deleted once a library deletes it). The delete instructions are gone, and what remains says to run setup_repo.py from the template repository. The manual route is the Publish workflow's dispatch from master, which is how every successful manual publish in the org has been done. Closes #15
AlexeyShalaev
force-pushed
the
fix/15-setup-docs
branch
from
October 16, 2026 15:01
686d4b6 to
07ab2f8
Compare
This was referenced Oct 17, 2026
Merged
Merged
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.
The problem
The setup instructions had drifted from what a render contains:
template/, so no render had it.README.mdand.claude/LIBRARY_CREATION.mdsaid togit rm scripts/setup_repo.py .claude/LIBRARY_CREATION.mdin the new library. Neither file is in a render, so the command fails.publish.ymllistens only to Release Please'sworkflow_runand toworkflow_dispatch, so that route ends in a tag and a Release, with nothing published and no error.The decision
template/NEW_LIBRARY_CHECKLIST.md.jinja). It already renders project-specific commands and tells the reader to delete it, and the "Done" list now ends with that step. I considered keeping it in the template repository and linking to it by URL. A rendered copy has the project's own slug, org and package name in every command, and with Generated projects have no .copier-answers.yml, so copier update cannot bring template fixes into them #14 in place it costs nothing later. I checked with Copier 9.19.1 that a library which deleted the checklist keeps it deleted throughcopier update, even after the template changes it.setup_repo.pyfrom the template repository after the first CI pass. That is the checklist's Step 3, and the only way it works..claude/LIBRARY_CREATION.md§3 now follows that order (generate, commit, create and push, then setup), and its checklists no longer ask to delete files that aren't there.gh workflow run publish.yml --ref master -f tag=<slug>-vX.Y.Z. All ten successful manual publishes in the org were done this way. It is also right after fix: publish only reviewed commits that passed CI #18, which keeps the input but only accepts it frommasterfor a tag onmasterwhose CI passed. The checklist now says that pushing a tag or creating a Release publishes nothing.Evidence
Render of
origin/masteragainst a render of this branch:The rendered Step 6 now reads:
The generated gate passes with the checklist present:
ruff(which excludes*.md) andmypyare clean, 1 test passed, anduv buildbuilds both files. The checklist is not in the sdist, whose include list is explicit.Closes #15