Skip to content

Commit

Permalink
Fixed up rules violations for command group help, `redis patch-schedu…
Browse files Browse the repository at this point in the history
…le show` (Azure#6042)

* fixed command group helps

* deprecate redis patch-schedule patch-schedule show

exclude command help

* updated version and history for redis

* updated versions for new help changes

* deprecation msg in redis indicates version of removal

* style
  • Loading branch information
williexu authored Apr 10, 2018
1 parent 73bcce6 commit 11607d4
Show file tree
Hide file tree
Showing 14 changed files with 49 additions and 12 deletions.
6 changes: 3 additions & 3 deletions src/command_modules/azure-cli-batch/HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Release History
===============

3.2.1
++++++
* Minor fixes
+++++
* Minor fixes.

3.2.0
++++++
+++++
* Updated to Batch SDK 4.1.1.
* `sdist` is now compatible with wheel 0.31.0

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,11 @@
short-summary: Manage Batch job schedules.
"""

helps['batch node service-logs'] = """
type: group
short-summary: Manage the service log files of a Batch compute node.
"""

helps['batch node user'] = """
type: group
short-summary: Manage the user accounts of a Batch compute node.
Expand Down Expand Up @@ -221,6 +226,11 @@
short-summary: View usage metrics of Batch pools.
"""

helps['batch pool node-counts'] = """
type: group
short-summary: Get node counts for Batch pools.
"""

helps['batch pool node-agent-skus'] = """
type: group
short-summary: Retrieve node agent SKUs of Batch pools using a Virtual Machine Configuration.
Expand Down
4 changes: 4 additions & 0 deletions src/command_modules/azure-cli-monitor/HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Release History
===============

0.1.6
+++++
* Minor fixes.

0.1.5
+++++
* Minor fixes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@
type: group
short-summary: Manage service diagnostic settings.
"""
helps['monitor diagnostic-settings categories'] = """
type: group
short-summary: Retrieve service diagnostic settings categories.
"""
helps['monitor diagnostic-settings create'] = """
type: command
short-summary: Create diagnostic settings for the specified resource.
Expand Down
2 changes: 1 addition & 1 deletion src/command_modules/azure-cli-monitor/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
logger.warn("Wheel is not available, disabling bdist_wheel hook")
cmdclass = {}

VERSION = "0.1.5"
VERSION = "0.1.6"
CLASSIFIERS = [
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
Expand Down
6 changes: 5 additions & 1 deletion src/command_modules/azure-cli-redis/HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@
Release History
===============

0.2.12

0.2.13
++++++
* Deprecated `redis patch-schedule patch-schedule show` in favor of `redis patch-schedule show`.

0.2.12
++++++
* `sdist` is now compatible with wheel 0.31.0

0.2.11
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,9 @@
type: group
short-summary: Manage Redis patch schedules.
"""

helps['redis patch-schedule patch-schedule'] = """
type: group
short-summary: This group is deprecated and will be removed in CLI version 2.0.36.
The command, `redis patch-schedule patch-schedule show`, will be replaced with `redis patch-schedule show`'
"""
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ def load_command_table(self, _):
with self.command_group('redis patch-schedule', redis_patch) as g:
g.command('set', 'create_or_update')
g.command('delete', 'delete')
g.command('patch-schedule show', 'get')
g.command('show', 'get')
g.command('patch-schedule show', 'get', deprecate_info="az redis patch-schedule show")
2 changes: 1 addition & 1 deletion src/command_modules/azure-cli-redis/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
logger.warn("Wheel is not available, disabling bdist_wheel hook")
cmdclass = {}

VERSION = "0.2.12"
VERSION = "0.2.13"
# The full list of classifiers is available at
# https://pypi.python.org/pypi?%3Aaction=list_classifiers
CLASSIFIERS = [
Expand Down
4 changes: 2 additions & 2 deletions src/command_modules/azure-cli-role/HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
Release History
===============

2.0.23
++++++
* Minor changes
* Minor fixes.

2.0.22
++++++

* `sdist` is now compatible with wheel 0.31.0

2.0.21
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@
type: command
short-summary: Get the details of a service principal.
"""
helps['ad app'] = """
type: group
short-summary: Manage applications with AAD Graph.
"""
helps['ad app delete'] = """
type: command
short-summary: Delete an application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
az {1} --ids $(az vm list -g MyResourceGroup --query "[].id" -o tsv)
"""

helps['vm secret'] = """
type: group
short-summary: Manage VM secrets.
"""

helps['vm secret add'] = """
type: command
short-summary: Add a secret to a VM.
Expand Down
4 changes: 2 additions & 2 deletions tools/automation/cli_linter/linter.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ def _get_loaded_help_description(self, entry):


class LinterManager(object):
def __init__(self, command_table=None, help_file_entries=None, loaded_help=None, exclusions={}):
def __init__(self, command_table=None, help_file_entries=None, loaded_help=None, exclusions=None):
self.linter = Linter(command_table=command_table, help_file_entries=help_file_entries, loaded_help=loaded_help)
self._exclusions = exclusions
self._exclusions = exclusions or {}
self._rules = {
'help_file_entries': [],
'command_groups': [],
Expand Down
1 change: 0 additions & 1 deletion tools/automation/cli_linter/rules/command_group_rules.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
from ..linter import RuleError


@exclude_from_ci
@command_group_rule
def missing_group_help_rule(linter, command_group_name):
if not linter.get_command_group_help(command_group_name):
Expand Down

0 comments on commit 11607d4

Please sign in to comment.