docs(registry): document how to add a package definition - #111
Merged
Conversation
The root README says "anyone can contribute — submit a PR" and links to registry/, but registry/ had no README and the repo has no CONTRIBUTING, so a contributor arriving there finds bare directories and has to open an issue to ask what the conventions are (#110). Documents what the code actually enforces: the directory is the distributing registry and the filename is the package name; a project distributed by no package manager gets a directory named after itself holding one self-named file, which is how python/ and java/ already work; scoped names use a subdirectory and Maven coordinates encode ':' as '_'. The trap worth writing down is the git-with-min_version shape. It needs a version-discovery API, which only npm, pip, maven and hex have, so anywhere else it throws "Unsupported registry: <dir>" — and one bad definition fails the whole nightly publish, taking every other package with it. Verified against the real CLI: the git-versioned shape in a docker/ directory fails with exactly that message, while unversioned-git resolves to latest and versioned-zip lists its explicit versions. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NBQQpA86yYzwJUiVz8ph2R
|
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 the gap behind #110.
The root README says "Anyone can contribute. If a library you use isn't listed, submit a PR to add it" and links to
registry/. There is noregistry/README.mdand noCONTRIBUTING.md, so a contributor who follows that link finds six bare directories and no way to learn the conventions except by opening an issue — which is exactly what happened.What it documents
Only things the code actually enforces, each verified against the CLI rather than read off the schema:
npm/@trpc/server.yaml); Maven coordinates encode:as_.python/python.yamlandjava/java.yamlalready work, which answers Documentation for Infrastructure Projects like Docker, Podman, Kubernetes #110 directly.docs_pathis wrong.The trap worth writing down
versions:withmin_version+ a git source asks a version-discovery API "which versions exist?" before matching them. Onlynpm,pip,mavenandhexhave such an API. Anywhere else it throws, and since one bad definition fails the whole nightly publish, it takes every other package down with it — the exact failure mode that kept the nightly red for five nights in a row earlier this month.Verified in a scratch registry:
So the guide steers non-package-manager projects to unversioned or zip, and says why.
Docs-only; no changeset (nothing published changes).
Generated by Claude Code