Skip to content

docs: deprecate the standalone keep-common fork - #35

Open
mswilkison wants to merge 1 commit into
mainfrom
codex/deprecate-keep-common
Open

mswilkison wants to merge 1 commit into
mainfrom
codex/deprecate-keep-common

Conversation

@mswilkison

Copy link
Copy Markdown
Contributor

keep-core's current dev release candidate has absorbed both the common runtime packages and generators, so it no longer needs this standalone fork. Add a prominent deprecation notice and a retirement plan that preserves the existing repository/module identity, tags, releases, and checksums for remaining consumers. No threshold-common replacement module is planned.

The plan makes archival conditional on the dev-to-main release, remaining-consumer retain/migrate decisions, and operational monitoring updates. CI stays active during that review, and maintenance publication remains available when agreed with affected owners. It also explains that keep-core's final in-tree layout is not a drop-in replacement module and that this decision does not deprecate the separate original Keep upstream. Correct the fork's build badge, contribution links, upstream link, and stale setup-go documentation.

Retirement work is tracked in #33. Related keep-core inventory: keep-core #4221. The source move is keep-core #4327, with the release tracked by keep-core #4256.

Validation:

  • Reviewed keep-core dev at a90ce1bf0738a35e4e3881f634f07520c2b8529e; imports, manifests, generator commands, and the resolved go mod graph contain no common-module dependency. The sole remaining textual reference is the intentional original upstream issue #117 link.
  • Checked local documentation links, referenced package/generator paths, and git diff --check.
  • Confirmed go.mod, go.sum, source code, and CI/release workflows are unchanged. This is a documentation-only PR; no runtime tests were needed for its final diff.

Merging this PR announces the deprecation plan. It does not archive the repository, publish a tag, or change a consumer's dependency pin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant