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

Create or Update Release Notes for js 2021-03 release #2501

Merged
merged 49 commits into from
Mar 17, 2021

Conversation

azure-sdk
Copy link
Collaborator

@azure-sdk azure-sdk commented Mar 3, 2021

Please use this PR for 2021-03 Js release notes update. Follow the guidelines below.

  • Release manager should remove all entries for packages that should not be in this release period.

    • You will have to remove it from the Release Highlights, Installation Instructions as well as the Updates, Beta or, GA section as the case may be.
    • Please don't remove the entries inside the HTML comments <!-- --> as that will cause the automation to re-add the entry on the next run.
    • Feel free to edit individual Release Highlights sections as you see fit.
  • Add new release entries to the PR if it has not already been added by the automation (it most likely will be).

    • Ensure to leave one line of space around (before and after) the special comments of the form [pattern.beta]: # (- ${PackageFriendlyName})
    • If there are packages that should be in this release that don't appear its probably because this automation runs at 12:30PM every weekday. If you released you package after 12:30PM you should wait till 12:30PM the next day and the automation would have picked it up.
    • To prevent the conflicts between the automation and manual edits, instead of pushing new commits you should make code suggestion on the PR, then allow the release manager to take care of merging everything in.
  • Leave feedback letting us know what group of packages should be kept out of the releases as well as any other issues you notice.

If you're looking for inspiration on release notes:

What's a Developer Impacting Change?.
Highlight guidelines: https://azure.github.io/azure-sdk/policies_releasenotes.html
September's PR: #1750
October's PR: #1878
November's PR: #2029
December's PR: #2138
January's PR: #2240
February's PR: #2333

releases/2021-03/js.md Outdated Show resolved Hide resolved
@@ -17,10 +21,13 @@ The Azure SDK team is pleased to make available the March 2021 client library re
[pattern.ga]: # (- ${PackageFriendlyName})

#### Updates
- Core - Abort Controller
- Core - Abort Controller
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chidozieononiwu for now perhaps the easies thing to do is make sure we don't have duplicate entries in these of these sections.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Core - Abort Controller

releases/2021-03/js.md Outdated Show resolved Hide resolved
@KarishmaGhiya
Copy link
Member

@weshaggard @chidozieononiwu We don't have @azure in the path for the sdks in JS. May be you can update the script to remove that?
Also, we don't include core libraries in JS release highlights. Here's the link to previous release - #2333. Do other languages include it?

@@ -39,6 +55,23 @@ To install the packages, copy and paste the below into a terminal.
If you have a bug or feature request for one of the libraries, please post an issue at the [azure-sdk-for-js repository](https://github.com/azure/azure-sdk-for-js/issues)

## Release highlights
### Identity 1.2.4-beta.1 [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/@azure/identity_1.2.4-beta.1/sdk/identity/identity/CHANGELOG.md#124-beta1-2021-02-12)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Identity released a patch this month, not this beta. This beta is older. https://www.npmjs.com/package/@azure/identity/v/1.2.4

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can see 02-12, that was when we released that beta. Should we include it even if it was out of band?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we had to pick one or the other, I would be more interesting in adding the patch release than the out of band.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chidozieononiwu Would you be able to update this? Or will we need to manually update the version and release notes this time for identity?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh turns out that this wasn't merged yet: Azure/azure-sdk-for-js#14124

Sorry, I've been too focused on some identity stuff.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It picked the older better because the automation basically started running from the date of last months release. So anything released since then will be grabbed. Feel free to remove it manually

@weshaggard
Copy link
Member

@weshaggard @chidozieononiwu We don't have @Azure in the path for the sdks in JS. May be you can update the script to remove that?

@chidozieononiwu we should do use the link templates to produce these changelog links similar to what https://github.com/Azure/azure-sdk/blob/master/eng/scripts/Update-Release-Versions.ps1#L213 is doing.

Also, we don't include core libraries in JS release highlights. Here's the link to previous release - #2333. Do other languages include it?

Unless there is a strong reason I'd wouldn't filter out the core release as that is still a package we release and we do display it in the package index so we should display it here as well.

@@ -39,6 +78,90 @@ To install the packages, copy and paste the below into a terminal.
If you have a bug or feature request for one of the libraries, please post an issue at the [azure-sdk-for-js repository](https://github.com/azure/azure-sdk-for-js/issues)

## Release highlights
### Identity 1.2.4 [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/da08c62c46e40271482c3ae957e04caf7bd2be2d/sdk/identity/identity/CHANGELOG.md#124-2021-03-08)
Copy link
Contributor

@czubair czubair Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KarishmaGhiya : please ensure you pull out specific highlights. see python rel notes : #2503

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add eventgrid to this list after they release. I see that storage has had minor version updates.(12.4.0 and 12.5.0). Do we pull out specific highlights for those as well or only the major version GA releases? @czubair

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only major unless the updates include something excitable to or asked for by customers

releases/2021-03/js.md Outdated Show resolved Hide resolved
@KarishmaGhiya KarishmaGhiya enabled auto-merge (squash) March 17, 2021 00:21
@KarishmaGhiya KarishmaGhiya merged commit caf6bfe into master Mar 17, 2021
@KarishmaGhiya KarishmaGhiya deleted the CreateOrUpdateReleaseNotesFor_js_2021-03 branch March 17, 2021 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.