Project

General

Profile

Bug #24964

Document how to deprecate commands

Added by Andrew Kofink about 1 year ago. Updated 3 months ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Target version:
-
Difficulty:
Triaged:
No
Bugzilla link:
Team Backlog:
Fixed in Releases:
Found in Releases:

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

Related to Hammer CLI - Tracker #24973: Tracker for missing documentationNew

Associated revisions

Revision f9c0e127 (diff)
Added by Oleh Fedorenko 6 months ago

Fixes #24964 - Document how to deprecate commands (#301)

History

#1 Updated by Tomáš Strachota about 1 year ago

#2 Updated by Oleh Fedorenko 7 months ago

  • Assignee set to Oleh Fedorenko
  • Status changed from New to Assigned

#3 Updated by The Foreman Bot 7 months 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 6 months ago

  • Status changed from Ready For Testing to Closed

#5 Updated by Martin Bacovsky 3 months ago

  • Fixed in Releases hammer-cli-0.17.0 added

Also available in: Atom PDF