refactor(docs)!: rename CLI binary to corestack-docs #17

2026-10-28T15:13:12-07:00

end commented

2026-10-28 15:13:12 -07:00

What

git mv cmd/docs cmd/corestack-docs; usage, error prefix and flag-set name now say corestack-docs.
.goreleaser.yaml: project name, build id/main/binary and archive name are corestack-docs.
Updated references in README.md, AGENTS.md, .gitea/workflows/docs-check.yml, docs/docs-format.md and docs/adr/README.md.
Accepted ADRs (20261023T214738672Z-…, 20261025T214616275Z-…): original text unchanged, plus a dated note in More Information saying the command was renamed. The repo's conventions only forbid renaming record files, not adding notes.

Why

go install go.auvem.com/corestack/cmd/docs@latest installs a binary named docs into $GOBIN. That name is ambiguous, and any other Go tool with a cmd/docs can overwrite it or be overwritten by it. This matches the existing corestack-goose naming. We are pre-1.0 (only v0.1.0 is tagged), so now is the cheapest time to rename.

Breaking change

After the next tag, go install go.auvem.com/corestack/cmd/docs@latest stops resolving. Use go install go.auvem.com/corestack/cmd/corestack-docs@latest. Pinned @v0.1.0 still works and installs the old docs binary. Release artifacts are renamed from docs_<ver>_<os>_<arch>.tar.gz to corestack-docs_…. The release notes for the next tag should call this out.

No compatibility shim (out of scope).

Checks run

go build ./..., go vet ./..., go test -race ./..., golangci-lint v2.15.0 (0 issues), go run ./cmd/corestack-docs check (ok: 5 records), TODO check: all pass.

Follow-ups in other repos

corestack/standards scaffold-project skill (and the docs policy baseline it copies): pinned documentation command / install line uses cmd/docs.
Any scaffolded project whose AGENTS.md or CI pins go run go.auvem.com/corestack/cmd/docs@…: fine while pinned to v0.1.0, but needs updating on upgrade.

🤖 Generated with Claude Code

## What - `git mv cmd/docs cmd/corestack-docs`; usage, error prefix and flag-set name now say `corestack-docs`. - `.goreleaser.yaml`: project name, build id/main/binary and archive name are `corestack-docs`. - Updated references in README.md, AGENTS.md, `.gitea/workflows/docs-check.yml`, `docs/docs-format.md` and `docs/adr/README.md`. - Accepted ADRs (`20261023T214738672Z-…`, `20261025T214616275Z-…`): original text unchanged, plus a dated note in More Information saying the command was renamed. The repo's conventions only forbid renaming record files, not adding notes. ## Why `go install go.auvem.com/corestack/cmd/docs@latest` installs a binary named `docs` into `$GOBIN`. That name is ambiguous, and any other Go tool with a `cmd/docs` can overwrite it or be overwritten by it. This matches the existing `corestack-goose` naming. We are pre-1.0 (only v0.1.0 is tagged), so now is the cheapest time to rename. ## Breaking change After the next tag, `go install go.auvem.com/corestack/cmd/docs@latest` stops resolving. Use `go install go.auvem.com/corestack/cmd/corestack-docs@latest`. Pinned `@v0.1.0` still works and installs the old `docs` binary. Release artifacts are renamed from `docs_<ver>_<os>_<arch>.tar.gz` to `corestack-docs_…`. **The release notes for the next tag should call this out.** No compatibility shim (out of scope). ## Checks run `go build ./...`, `go vet ./...`, `go test -race ./...`, golangci-lint v2.15.0 (0 issues), `go run ./cmd/corestack-docs check` (ok: 5 records), TODO check: all pass. ## Follow-ups in other repos - corestack/standards `scaffold-project` skill (and the docs policy baseline it copies): pinned documentation command / install line uses `cmd/docs`. - Any scaffolded project whose AGENTS.md or CI pins `go run go.auvem.com/corestack/cmd/docs@…`: fine while pinned to v0.1.0, but needs updating on upgrade. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

end added 1 commit 2026-10-28 15:13:12 -07:00

refactor(docs)!: rename CLI binary to corestack-docs

Documentation / docs (pull_request) Successful in 16s

Details

ci / check (pull_request) Successful in 27s

Details

Documentation / docs (push) Successful in 16s

Details

ci / check (push) Successful in 27s

Details

0034a561ba

go install names binaries after the directory, so cmd/docs installed an
ambiguous `docs` binary into $GOBIN that could clobber or be clobbered
by other tools. Move it to cmd/corestack-docs, matching corestack-goose,
and update goreleaser, CI, docs and usage text. Accepted ADRs keep their
text and gain a dated rename note.

BREAKING CHANGE: `go install go.auvem.com/corestack/cmd/docs@latest`
stops resolving after the next tag; use cmd/corestack-docs. @v0.1.0
still installs the old `docs` binary.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

end merged commit 0034a561ba into main

2026-10-28 15:16:50 -07:00

end referenced this issue from a commit

2026-10-28 15:17:38 -07:00

fix(scaffold-project): use corestack-docs checker and current action majors

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: corestack/go#17