Bug #24964
Document how to deprecate commands
Difficulty:
Triaged:
No
Pull request:
Team Backlog:
Description
This PR (https://github.com/theforeman/hammer-cli/pull/251) introduced the ':warning' and ':hidden' options to subcommands, allowing us to show deprecation warnings when a user uses the command (e.g. https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman.rb#L106). We should have some documentation in the readme to show how this is done rather than relying on developers to search through PRs and grep code to figure it out.
Related issues
Associated revisions
History
#1
Updated by Tomáš Strachota over 4 years ago
- Related to Tracker #24973: Tracker for missing documentation added
#2
Updated by Oleh Fedorenko almost 4 years ago
- Assignee set to Oleh Fedorenko
- Status changed from New to Assigned
#3
Updated by The Foreman Bot almost 4 years ago
- Status changed from Assigned to Ready For Testing
- Pull request https://github.com/theforeman/hammer-cli/pull/301 added
#4
Updated by Oleh Fedorenko almost 4 years ago
- Status changed from Ready For Testing to Closed
Applied in changeset f9c0e127b32b69d65527e648249177c94ca8bfd6.
#5
Updated by Martin Bacovsky over 3 years ago
- Fixed in Releases hammer-cli-0.17.0 added
Fixes #24964 - Document how to deprecate commands (#301)