Support Multi-line Upcoming Breaking Change announcement (#515)

* Support Multi-line Upcoming Breaking Change announcement

* Prepare to release

* Fix title underline

* Use clear name

* Upgrade to 0.2.0 !!

Author: ReaNAiveD

HISTORY.rst

@@ -2,6 +2,10 @@
 
 Release History
 ===============
+0.2.0
++++++
+* `azdev generated-breaking-change-report`: Support multi-line upcoming breaking change announcement
+
 0.1.99
 ++++++
 * `azdev verify`: Fix executable inconsistence in `subprocess`

azdev/__init__.py

@@ -4,4 +4,4 @@
 # license information.
 # -----------------------------------------------------------------------------
 
-__VERSION__ = '0.1.99'
+__VERSION__ = '0.2.0'

azdev/operations/breaking_change/__init__.py

@@ -36,6 +36,11 @@ def calc_ref(self, loader):
         else:
             self.group_ref = self.command.split()[:-1]
 
+    @property
+    def prepended_detail(self):
+        prepended_lines = [f'- {line}' if line else '' for line in self.detail.split('\n')]
+        return '\n'.join(prepended_lines)
+
 
 def _load_commands():
     start = time.time()
@@ -300,9 +305,9 @@ def _group_breaking_change_items(iterator, group_by_version=False):
         version = item.target_version if item.target_version else 'Unspecific'
         upcoming_breaking_changes[item.module][item.command]['group_ref'] = item.group_ref
         if group_by_version:
-            upcoming_breaking_changes[item.module][item.command]['items'][version].append(item.detail)
+            upcoming_breaking_changes[item.module][item.command]['items'][version].append(item.prepended_detail)
         else:
-            upcoming_breaking_changes[item.module][item.command]['items'].append(item.detail)
+            upcoming_breaking_changes[item.module][item.command]['items'].append(item.prepended_detail)
     return upcoming_breaking_changes
 
 

azdev/operations/breaking_change/markdown_template.jinja2

@@ -21,14 +21,14 @@ The breaking changes listed in this article are planned for the next major relea
 ###{%- if not module == 'core' -%}#{%- endif %} Deprecated in {{ version }}
 
 {% for bc in bcs -%}
-- {{ bc.detail }}
+{{ bc }}
 {% endfor %}
 
 {% endfor -%}
 {% else -%}
 
 {% for bc in multi_version_bcs['items'] -%}
-- {{ bc }}
+{{ bc }}
 {% endfor %}
 
 {% endif -%}