Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog Verification CI failed for First GA packages #30156

Closed
kazrael2119 opened this issue Jun 24, 2024 · 6 comments · Fixed by Azure/azure-sdk-tools#8498
Closed

Changelog Verification CI failed for First GA packages #30156

kazrael2119 opened this issue Jun 24, 2024 · 6 comments · Fixed by Azure/azure-sdk-tools#8498
Labels
Central-EngSys This issue is owned by the Engineering System team.

Comments

@kazrael2119
Copy link
Contributor

kazrael2119 commented Jun 24, 2024

We have two first GA release this week:
#30012
#30154
but both of them get failed on Changelog Verification check in pipeline with the error message

Usually, if a package is going to be first GA, the changelog will be

# Release History
    
## 1.0.0 (2024-06-24)

The package of @azure/arm-resourcesdeploymentstacks is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).

which doesn't have any code details.
not sure whether a first beta package will trigger this error too.

cc @qiaozha @MaryGao

@github-actions github-actions bot added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jun 24, 2024
@MaryGao
Copy link
Member

MaryGao commented Jun 24, 2024

The message told you the error:

##[error]The changelog entry did not contain any of the recommended sections (Features Added, Breaking Changes, Bugs Fixed, Other Changes), please add at least one. See https://aka.ms/azsdk/guideline/changelogs for more info.

##[error]PowerShell exited with code '1'.

I prefer to change to something like below:

# Release History
    
## 1.0.0-beta.1 (2024-06-24)

### Features Added

The package of @azure/arm-resourcesdeploymentstacks is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).

For GA:

# Release History
    
## 1.0.0 (2024-06-24)

### Features Added

This is the first GA for @azure/arm-resourcesdeploymentstacks and the package is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).

@qiaozha
Copy link
Member

qiaozha commented Jun 24, 2024

Normally feature added means minor change, but GA/preview track2 maybe Modular when MPG is ready is not.
but if we call it breaking change, it would be weird if we don't show them what is breaking.

@qiaozha
Copy link
Member

qiaozha commented Jun 24, 2024

@joheredi @xirzec Could you help share your insights here? Thank you

@xirzec
Copy link
Member

xirzec commented Jun 24, 2024

Seems like enforcement was recently changed to block on this: Azure/azure-sdk-tools#8463

"Features Added" is probably the most correct thing to use, and appears to be what others have used for the initial release: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/openai/Azure.AI.OpenAI/CHANGELOG.md#100-beta1-2023-02-06

Perhaps we could make the check smarter about not enforcing recommended sections on the first release though? @weshaggard

@xirzec xirzec added Central-EngSys This issue is owned by the Engineering System team. and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Jun 24, 2024
@weshaggard
Copy link
Member

weshaggard commented Jun 24, 2024

The guidelines have always listed having a required section heading however we recently discovered a bug which didn't correctly fail the validation step, which has been fixed.

I don't think we need to special case new releases we should use "Features Added" for those cases.

@xirzec xirzec closed this as completed Jun 24, 2024
@github-project-automation github-project-automation bot moved this from 🤔 Triage to 🎊 Closed in Azure SDK EngSys 🚢🎉 Jun 24, 2024
@wanlwanl
Copy link
Member

FYI, current state here: Azure/azure-sdk-tools#8487

wanlwanl added a commit to wanlwanl/wanl-fork-azure-sdk-tools that referenced this issue Jun 25, 2024
wanlwanl added a commit to wanlwanl/wanl-fork-azure-sdk-tools that referenced this issue Jun 25, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Sep 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Central-EngSys This issue is owned by the Engineering System team.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

6 participants