Skip to content

feat: auto-generate deprecation warning box from YAML config#941

Draft
chaptersix wants to merge 1 commit intotemporalio:mainfrom
chaptersix:feat/auto-deprecation-warning
Draft

feat: auto-generate deprecation warning box from YAML config#941
chaptersix wants to merge 1 commit intotemporalio:mainfrom
chaptersix:feat/auto-deprecation-warning

Conversation

@chaptersix
Copy link
Contributor

Summary

  • Add deprecated: true field to command YAML config to auto-generate CAUTION deprecation box
  • Add optional deprecation-message field for custom deprecation messages
  • Remove need to manually add deprecation warning boxes to command descriptions

Usage

# Default message: "This command is deprecated and will be removed in a later release."
- name: temporal some-command
  deprecated: true
  description: |
    Command description here...

# Custom message
- name: temporal other-command
  deprecated: true
  deprecation-message: This API has been deprecated by Worker Deployment.
  description: |
    Command description here...

Test plan

  • Unit tests for generateDeprecationBox() function
  • Verified code generation produces correct output
  • All existing tests pass

Add `deprecated: true` and optional `deprecation-message` fields to
command YAML config. When set, the generator auto-prepends a CAUTION
box to the command description, removing the need to manually add
deprecation warnings.
@chaptersix chaptersix requested review from a team as code owners February 6, 2026 22:59
@chaptersix chaptersix marked this pull request as draft February 7, 2026 01:26
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