Project

General

Profile

Actions
Copy link

Bug #24964

closed

Document how to deprecate commands

Added by Andrew Kofink over 5 years ago. Updated almost 5 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Oleh Fedorenko
Category:
Documentation
Target version:
-
Difficulty:
Triaged:
No
Bugzilla link:
Pull request:
https://github.com/theforeman/hammer-cli/pull/301
Team Backlog:
Fixed in Releases:
hammer-cli-0.17.0
Found in Releases:
In Kanboard:
Red Hat JIRA:

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 1 (0 open — 1 closed)

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

Actions
Actions
Copy link
 #1

Updated by Tomáš Strachota over 5 years ago

Actions
Copy link
 #2

Updated by Oleh Fedorenko about 5 years ago

  • Status changed from New to Assigned
  • Assignee set to Oleh Fedorenko
Actions
Copy link
 #3

Updated by The Foreman Bot about 5 years ago

  • Status changed from Assigned to Ready For Testing
  • Pull request https://github.com/theforeman/hammer-cli/pull/301 added
Actions
Copy link
 #4

Updated by Oleh Fedorenko about 5 years ago

  • Status changed from Ready For Testing to Closed
Actions
Copy link
 #5

Updated by Martin Bacovsky almost 5 years ago

  • Fixed in Releases hammer-cli-0.17.0 added
Actions
Copy link

Also available in: Atom PDF