docs: add release and add-lint-rule runbooks, fix stale Maven steps - #564
Merged
Conversation
The two recurring jobs in this repo — cutting a release and adding a lint rule — were either undocumented or documented wrongly. CONTRIBUTING.md still told maintainers to promote Maven artifacts by hand via s01.oss.sonatype.org. That has not been true for a while: goreleaser uploads to the Central Publisher Portal with `publishing_type=automatic`. v0.57.0 reached Maven Central today with no manual staging step. Releasing is also more than `release.sh`: one tag fans out to six channels that fail independently, and `publish_npm` / `publish_wheel` trigger on goreleaser's *completion*, not its success — so a green goreleaser is not evidence that anything was published. The runbook says to check the registries directly and covers the failure modes hit while shipping v0.57.0. Adding a rule spans eight files; implementing `Apply` without registering the rule in `subcmds/rules.go` leaves it invisible, and `IsOfficial()` silently decides whether it is on by default. .claude/settings.local.json is ignored, since it is per-developer. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Documents this repo's two recurring jobs as Claude Code skills, and corrects a set of release instructions that no longer match what CI does. Fallout from shipping v0.57.0 (#557).
The stale part
CONTRIBUTING.mdtold maintainers to promote Maven artifacts by hand:That has not been true for a while.
goreleaser.ymluploads to the Central Publisher Portal withpublishing_type=automatic, and today's release confirms it — nobody touched a staging repo, yet:which is minutes after the goreleaser run finished.
.claude/skills/releaseReleasing is more than
release.sh. One tag fans out to six channels, andpublish_npm/publish_wheeltrigger on goreleaser's completion, not its success — so a green goreleaser badge is not evidence that anything was published. That is exactly how the npm package sat a year behind while every other channel kept shipping.The runbook therefore leans on verifying the registries directly rather than the workflow badges, plus an end-to-end
npm installthat exercisespostinstall.js. It also records the failure modes hit while shipping v0.57.0, so the next person does not have to re-derive them:404 ... PUT https://registry.npmjs.org/protolintmeans auth, not a missing packagepublish_npm.ymlbreaks publishing, because the trusted publisher registration matches on the filenamefatal: No tags can describe '<sha>'is a shallow-checkout problembin[...] was invalid and removedwarning is harmless.claude/skills/add-lint-ruleAdding a rule spans eight files. Implementing
Applywithout registering the rule ininternal/cmd/subcmds/rules.goleaves it invisible to users, andIsOfficial()quietly decides whether it is enabled by default (Rules.Default()filters on it). The skill tabulates every file to touch, the mechanical naming convention, and how fixable / auto-disable are wired.Verified
go run cmd/protolint/main.go listbehaves as the skill describes.Also
README.mdgains a pointer from its Release section to the full process.claude/settings.local.jsonis gitignored — it is per-developer, and was previously only ignored via a personal global gitignore🤖 Generated with Claude Code