Project

General

Profile

Bug #24964

Document how to deprecate commands

Added by Andrew Kofink over 4 years ago. Updated over 3 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

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

Associated revisions

Revision f9c0e127 (diff)
Added by Oleh Fedorenko almost 4 years ago

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

History

#1 Updated by Tomáš Strachota over 4 years ago

#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

#5 Updated by Martin Bacovsky over 3 years ago

  • Fixed in Releases hammer-cli-0.17.0 added

Also available in: Atom PDF