Skip to content

docs(readme): clarify maintenance status and V2 transition - #915

Merged
krokoko merged 1 commit into
mainfrom
docs/readme-maintenance
Sep 22, 2026
Merged

krokoko merged 1 commit into
mainfrom
docs/readme-maintenance

Conversation

@krokoko

@krokoko krokoko commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

The README now explains that the current version remains usable and is not deprecated, with continued updates and security fixes in maintenance mode. It introduces V2 as the next version and signals a future transition while making clear that no migration is required now.

Area

  • cdk — infrastructure, handlers, constructs
  • agent — Python runtime / Docker image
  • cli — bgagent client
  • docs — root README
  • tooling — root mise.toml, scripts, CI workflows

Related

No linked issue.

Changes

  • Add the maintenance and V2 notice directly below the stability badge.
  • Replace the active-development statement with a reference to the notice.

Validation

  • git diff --check and the README pre-commit checks passed, including the staged secret scan.
  • mise run build: the agent and CLI suites, documentation build, CDK synthesis, and 221 of 222 CDK suites passed. One CDK test failed with ENOENT while asset staging read a temporary Jest cache file.
  • Focused rerun of test/main.test.ts: all 9 tests passed with the Jest cache outside the repository, generated output excluded from discovery, and an 8 GiB Node heap. The initial isolated attempt exceeded the default Node heap limit.

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

Co-Authored-By: Codex noreply@openai.com

Explain that the current version remains usable and is not deprecated, with continued maintenance updates and security fixes. Introduce V2 and make clear that no migration is required now.

Co-Authored-By: Codex <noreply@openai.com>
@krokoko
krokoko requested review from a team and backgroundagents as code owners September 22, 2026 19:19
@krokoko
krokoko enabled auto-merge September 22, 2026 19:32
@krokoko
krokoko added this pull request to the merge queue Sep 22, 2026
Merged via the queue into main with commit 093ac88 Sep 22, 2026
8 checks passed
@krokoko
krokoko deleted the docs/readme-maintenance branch September 22, 2026 20:14
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.

3 participants