azdev generate-breaking-change-report: New command to collect Upcoming Breaking Changes from codebase

[ReaNAiveD]

Command

azdev generate-breaking-change-report

Description

Add a new command to collect upcoming breaking changes from codebase.

The new command is related to the 'pre-announce Breaking Changes' feature in Azure CLI repo.

Parameters

• modules: Positional argument. The module used to generate the report, usually CLI or a specific module.
• target_version: Only the breaking changes scheduled prior to the specified version will be displayed. By default this is the next breaking change window. It could be set to None to collect all announced breaking changes.
• source: deprecate_info or pre_announce. The source of pre-announced breaking changes.
  • deprecate_info represents all breaking changes marked through deprecation_info(including pre-announnced breaking changes since they would also be converted into deprecate_info during runtime);
  • pre_announce represents the breaking changes announced in breaking_change.py file.
• group_by_version: If specified, breaking changes would be grouped by their target version as well.
• output_format: structure or markdown. Output format of the collected breaking changes.

Usage Example

# Collect all pre-announced breaking changes, including any that did not specify a target version and group them by target version
azdev generate-breaking-change-report CLI --group-by-version --target-version None

# Collect all pre-announced breaking changes target before next breaking change window, and display them in markdown
azdev generate-breaking-change-report CLI --output-format markdown

# Collect all pre-announced breaking changes in vm, including those failed to specify a target version, and display them in json
azdev generate-breaking-change-report vm --target-version None