Skip to content

[Feature]: shorten change log for upcoming release #28438

@isra-fel

Description

@isra-fel

Description of the new feature

Context

Azure PowerShell publishes a rollup module named "Az" whose release notes is a combination of every modules' change log. Because PowerShell Gallery has a limitation on the length of release notes, we need to make sure the change logs of individual modules are concise.

Problem

The problem this feature request tries to address is the overly long change logs introduced by breaking change announcements. Here is one example: https://github.com/Azure/azure-powershell/blob/main/src/ContainerRegistry/ContainerRegistry/ChangeLog.md

In this example, all the cmdlets impacted by the breaking change are listed, but it only adds unnecessary length because a full version of the breaking change can be found in the official document https://learn.microsoft.com/powershell/azure/upcoming-breaking-changes

Solution

Look for all change logs that match the above pattern in problem description, shorten them as "Preannounced breaking changes. Please refer to https://go.microsoft.com/fwlink/?linkid=2333229".

Notes

  • All change log files: src/*/*/ChangeLog.md
  • Only consider the content under the "Upcoming Release" header in each ChangeLog.md. Do not change previous versions.

Proposed implementation details (optional)

No response

Metadata

Metadata

Assignees

Labels

feature-requestThis issue requires a new behavior in the product in order be resolved.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions