Support trim head and tail in markdown breaking change report generation (#509)

* Support new parameter no-head and no-tail in markdown report generation

* Release

Author: ReaNAiveD

HISTORY.rst

@@ -2,6 +2,10 @@
 
 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/__init__.py

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

azdev/operations/breaking_change/__init__.py

@@ -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
@@ -339,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/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/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.')