azdev 0.1.94__tar.gz → 0.1.96__tar.gz

{azdev-0.1.94 → azdev-0.1.96}/HISTORY.rst

@@ -2,6 +2,16 @@
 
 Release History
 ===============
+0.1.96
+++++++
+* `azdev generate-breaking-change-report`: Add `--no-head` and `--no-tail` to support trim header and tail in markdown report.
+
+0.1.95
+++++++
+* `azdev generate-breaking-change-report`: Extracts upcoming breaking changes in extensions, regardless of the target version set
+* `azdev generate-breaking-change-report`: Fix collecting announcement starting with `az`
+
+
 0.1.94
 ++++++
 * `azdev command-change meta-export`: Enable meta exporting for extension installed using `.whl` package by `include_whl_extensions`

{azdev-0.1.94/azdev.egg-info → azdev-0.1.96}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: azdev
-Version: 0.1.94
+Version: 0.1.96
 Summary: Microsoft Azure CLI Developer Tools
 Home-page: https://github.com/Azure/azure-cli-dev-tools
 Author: Microsoft Corporation
@@ -40,7 +40,7 @@ Requires-Dist: azure-cli-diff-tool~=0.0.6
 Requires-Dist: packaging
 Requires-Dist: tqdm
 Requires-Dist: wheel==0.30.0
-Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b2
+Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b4
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -158,6 +158,16 @@ License
 
 Release History
 ===============
+0.1.96
+++++++
+* `azdev generate-breaking-change-report`: Add `--no-head` and `--no-tail` to support trim header and tail in markdown report.
+
+0.1.95
+++++++
+* `azdev generate-breaking-change-report`: Extracts upcoming breaking changes in extensions, regardless of the target version set
+* `azdev generate-breaking-change-report`: Fix collecting announcement starting with `az`
+
+
 0.1.94
 ++++++
 * `azdev command-change meta-export`: Enable meta exporting for extension installed using `.whl` package by `include_whl_extensions`

{azdev-0.1.94 → azdev-0.1.96}/azdev/__init__.py

@@ -4,4 +4,4 @@
 # license information.
 # -----------------------------------------------------------------------------
 
-__VERSION__ = '0.1.94'
+__VERSION__ = '0.1.96'

{azdev-0.1.94 → azdev-0.1.96}/azdev/operations/breaking_change/__init__.py

@@ -13,6 +13,7 @@ from knack.log import get_logger
 
 from azdev.operations.statistics import _create_invoker_and_load_cmds  # pylint: disable=protected-access
 from azdev.utilities import require_azure_cli, display, heading, output, calc_selected_mod_names
+from azdev.utilities.path import calc_selected_modules
 
 # pylint: disable=no-else-return
 
@@ -68,8 +69,9 @@ def _handle_custom_breaking_changes(module, command):
     """
     from azure.cli.core.breaking_change import upcoming_breaking_changes
     yield from _handle_custom_breaking_change(module, command, upcoming_breaking_changes.get(command))
+    yield from _handle_custom_breaking_change(module, command, upcoming_breaking_changes.get(f'az {command}'))
     for key in upcoming_breaking_changes:
-        if key.startswith(command + '.'):
+        if key.startswith(command + '.') or key.startswith(f'az {command}.'):
             yield from _handle_custom_breaking_change(module, command, upcoming_breaking_changes[key])
 
 
@@ -249,9 +251,7 @@ def _handle_core(source):
     display('Core finished loaded in {} sec'.format(stop - start))
 
 
-def _handle_upcoming_breaking_changes(selected_mod_names, source):
-    command_loader = _load_commands()
-
+def _handle_upcoming_breaking_changes(command_loader, selected_mod_names, source):
     if 'core' in selected_mod_names or 'azure-cli-core' in selected_mod_names:
         yield from _handle_core(source)
 
@@ -285,13 +285,13 @@ def _filter_breaking_changes(iterator, max_version=None):
 # pylint: disable=unnecessary-lambda-assignment
 def _group_breaking_change_items(iterator, group_by_version=False):
     if group_by_version:
-        upcoming_breaking_changes = defaultdict(    # module to command
-            lambda: defaultdict(    # command to version
-                lambda: {'group_ref': None, 'items': defaultdict(    # version to list of breaking changes
+        upcoming_breaking_changes = defaultdict(  # module to command
+            lambda: defaultdict(  # command to version
+                lambda: {'group_ref': None, 'items': defaultdict(  # version to list of breaking changes
                     lambda: [])}))
     else:
-        upcoming_breaking_changes = defaultdict(    # module to command
-            lambda: defaultdict(    # command to list of breaking changes
+        upcoming_breaking_changes = defaultdict(  # module to command
+            lambda: defaultdict(  # command to list of breaking changes
                 lambda: {'group_ref': None, 'items': []}))
     for item in iterator:
         version = item.target_version if item.target_version else 'Unspecific'
@@ -304,7 +304,7 @@ def _group_breaking_change_items(iterator, group_by_version=False):
 
 
 def collect_upcoming_breaking_changes(modules=None, target_version='NextWindow', source=None, group_by_version=None,
-                                      output_format='structure'):
+                                      output_format='structure', no_head=False, no_tail=False):
     if target_version == 'NextWindow':
         from azure.cli.core.breaking_change import NEXT_BREAKING_CHANGE_RELEASE
         target_version = NEXT_BREAKING_CHANGE_RELEASE
@@ -313,14 +313,24 @@ def collect_upcoming_breaking_changes(modules=None, target_version='NextWindow',
 
     require_azure_cli()
 
-    selected_mod_names = calc_selected_mod_names(modules)
+    selected_modules = calc_selected_modules(modules)
+    cli_mod_names = list(selected_modules['core'].keys()) + list(selected_modules['mod'].keys())
+    ext_mod_names = list(selected_modules['ext'].keys())
 
-    if selected_mod_names:
-        display('Modules selected: {}\n'.format(', '.join(selected_mod_names)))
+    if cli_mod_names or ext_mod_names:
+        display('Modules selected: {}\n'.format(', '.join(cli_mod_names + ext_mod_names)))
+
+    command_loader = _load_commands()
 
     heading('Collecting Breaking Change Pre-announcement')
-    breaking_changes = _handle_upcoming_breaking_changes(selected_mod_names, source)
-    breaking_changes = _filter_breaking_changes(breaking_changes, target_version)
+    breaking_changes = []
+    if cli_mod_names:
+        cli_breaking_changes = _handle_upcoming_breaking_changes(command_loader, cli_mod_names, source)
+        cli_breaking_changes = _filter_breaking_changes(cli_breaking_changes, target_version)
+        breaking_changes.extend(cli_breaking_changes)
+    if ext_mod_names:
+        ext_breaking_changes = _handle_upcoming_breaking_changes(command_loader, ext_mod_names, 'pre_announce')
+        breaking_changes.extend(ext_breaking_changes)
     breaking_changes = _group_breaking_change_items(breaking_changes, group_by_version)
     if output_format == 'structure':
         return breaking_changes
@@ -329,5 +339,9 @@ def collect_upcoming_breaking_changes(modules=None, target_version='NextWindow',
         env = Environment(loader=PackageLoader('azdev', 'operations/breaking_change'),
                           trim_blocks=True)
         template = env.get_template('markdown_template.jinja2')
-        output(template.render({'module_bc': breaking_changes}))
+        output(template.render({
+            'module_bc': breaking_changes,
+            'no_head': no_head,
+            'no_tail': no_tail,
+        }))
     return None

{azdev-0.1.94 → azdev-0.1.96}/azdev/operations/breaking_change/markdown_template.jinja2

@@ -1,7 +1,9 @@
+{% if not no_head -%}
 # Upcoming breaking changes in Azure CLI
 
 The breaking changes listed in this article are planned for the next major release of the Azure CLI unless otherwise noted. Per our [Support lifecycle](./azure-cli-support-lifecycle.md), breaking changes in Azure CLI Core reference groups occur twice a year.
 
+{% endif -%}
 {% for module, command_bc in module_bc.items() -%}
 ## {{ module }}
 
@@ -32,6 +34,7 @@ The breaking changes listed in this article are planned for the next major relea
 {% endif -%}
 {% endfor -%}
 {% endfor -%}
-
+{% if not no_tail %}
 > [!NOTE]
-> This article provides information on upcoming breaking changes. For previously published breaking changes, see [Azure CLI release notes](./release-notes-azure-cli.md).
+> This article provides information on upcoming breaking changes. For previously published breaking changes, see [Azure CLI release notes](./release-notes-azure-cli.md).
+{%- endif -%}

{azdev-0.1.94 → azdev-0.1.96}/azdev/operations/linter/rules/command_group_rules.py

@@ -54,12 +54,16 @@ def disallowed_html_tag_from_command_group(linter, command_group_name):
                                                                              linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in short summary. "
                         "If the content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
     if help_entry.long_summary and (disallowed_tags := has_illegal_html_tag(help_entry.long_summary,
                                                                             linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in long summary. "
                         "If content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 

{azdev-0.1.94 → azdev-0.1.96}/azdev/operations/linter/rules/command_rules.py

@@ -49,12 +49,16 @@ def disallowed_html_tag_from_command(linter, command_name):
                                                                              linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in short summary. "
                         "If the content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
     if help_entry.long_summary and (disallowed_tags := has_illegal_html_tag(help_entry.long_summary,
                                                                             linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in long summary. "
                         "If content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 

{azdev-0.1.94 → azdev-0.1.96}/azdev/operations/linter/rules/parameter_rules.py

@@ -183,6 +183,8 @@ def disallowed_html_tag_from_parameter(linter, command_name, parameter_name):
                                                                              linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in short summary. "
                         "If the content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 
@@ -190,6 +192,8 @@ def disallowed_html_tag_from_parameter(linter, command_name, parameter_name):
                                                                             linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in long summary. "
                         "If content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 

{azdev-0.1.94 → azdev-0.1.96}/azdev/params.py

@@ -276,3 +276,5 @@ def load_arguments(self, _):
                    help='If specified, breaking changes would be grouped by their target version as well.')
         c.argument('output_format', choices=['structure', 'markdown'], default='structure',
                    help='Output format of the collected breaking changes.')
+        c.argument('no_head', action='store_true', help='Skip head when displaying as markdown.')
+        c.argument('no_tail', action='store_true', help='Skip tail when displaying as markdown.')

{azdev-0.1.94 → azdev-0.1.96}/azdev/utilities/path.py

@@ -265,7 +265,7 @@ def get_path_table(include_only=None, include_whl_extensions=False):
     return table
 
 
-def calc_selected_mod_names(modules=None):
+def calc_selected_modules(modules=None):
     # allow user to run only on CLI or extensions
     cli_only = modules == ['CLI']
     ext_only = modules == ['EXT']
@@ -280,6 +280,12 @@ def calc_selected_mod_names(modules=None):
         selected_modules['core'] = {}
         selected_modules['mod'] = {}
 
+    return selected_modules
+
+
+def calc_selected_mod_names(modules=None):
+    selected_modules = calc_selected_modules(modules)
+
     if not any(selected_modules.values()):
         logger.warning('No commands selected to check.')
 

{azdev-0.1.94 → azdev-0.1.96/azdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: azdev
-Version: 0.1.94
+Version: 0.1.96
 Summary: Microsoft Azure CLI Developer Tools
 Home-page: https://github.com/Azure/azure-cli-dev-tools
 Author: Microsoft Corporation
@@ -40,7 +40,7 @@ Requires-Dist: azure-cli-diff-tool~=0.0.6
 Requires-Dist: packaging
 Requires-Dist: tqdm
 Requires-Dist: wheel==0.30.0
-Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b2
+Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b4
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -158,6 +158,16 @@ License
 
 Release History
 ===============
+0.1.96
+++++++
+* `azdev generate-breaking-change-report`: Add `--no-head` and `--no-tail` to support trim header and tail in markdown report.
+
+0.1.95
+++++++
+* `azdev generate-breaking-change-report`: Extracts upcoming breaking changes in extensions, regardless of the target version set
+* `azdev generate-breaking-change-report`: Fix collecting announcement starting with `az`
+
+
 0.1.94
 ++++++
 * `azdev command-change meta-export`: Enable meta exporting for extension installed using `.whl` package by `include_whl_extensions`

{azdev-0.1.94 → azdev-0.1.96}/azdev.egg-info/requires.txt

@@ -18,4 +18,4 @@ azure-cli-diff-tool~=0.0.6
 packaging
 tqdm
 wheel==0.30.0
-microsoft-security-utilities-secret-masker~=1.0.0b2
+microsoft-security-utilities-secret-masker~=1.0.0b4

{azdev-0.1.94 → azdev-0.1.96}/setup.py

@@ -87,7 +87,7 @@ setup(
         'packaging',
         'tqdm',
         'wheel==0.30.0',
-        'microsoft-security-utilities-secret-masker~=1.0.0b2'
+        'microsoft-security-utilities-secret-masker~=1.0.0b4'
     ],
     package_data={
         'azdev.config': ['*.*', 'cli_pylintrc', 'ext_pylintrc'],