Skip to content

docs(policy): pin retirement version for deprecated [engine] block - #811

Draft
gmoncor wants to merge 1 commit into
bmad-code-org:mainfrom
gmoncor:docs/s01-11-pin-retirement-version-deprecated-engine
Draft

gmoncor wants to merge 1 commit into
bmad-code-org:mainfrom
gmoncor:docs/s01-11-pin-retirement-version-deprecated-engine

Conversation

@gmoncor

@gmoncor gmoncor commented Sep 17, 2026

Copy link
Copy Markdown

What: Pin a concrete target version (and tracking issue) for retiring the [engine] compatibility alias, in both the code comment and the runtime DeprecationWarning message.

Why: The alias says it is a "one-release" compatibility shim but names no version or issue, so nothing owns its removal — it can (and likely will) outlive its intended lifetime, matching a known anti-pattern already called out in this project's own review conventions.

How:

  • Replace "a future release" / "one-release compatibility alias" with a concrete version number (0.12.0) in the code comment and the warnings.warn message.
  • Reference tracking issue Remove deprecated [engine] compatibility block in policy.py #810 for the removal, following the #149/#156/#157 convention already used elsewhere in this same file.

Testing: uv run pytest -q tests/test_policy.py — 352 passed, 2 skipped. Confirms the deprecation-warning path still matches the updated message text.

Changelog: Changed: pinned a target version for the deprecated [engine] settings block.

Related to #810

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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