Create or Update Release Notes for python 2021-03 release #2503
Conversation
azure-sdk
requested review from
alzimmermsft,
czubair,
jeremymeng,
kinelski,
kyle-patterson,
Mohit-Chakraborty,
ShivangiReja and
xiangyan99
as code owners
| ### azure-mgmt-servicefabricmanagedclusters 1.0.0b1 [Changelog](https://github.com/Azure/azure-sdk-for-python/blob/azure-mgmt-servicefabricmanagedclusters_1.0.0b1/sdk/servicefabricmanagedclusters/azure-mgmt-servicefabricmanagedclusters/CHANGELOG.md#100b1-2021-02-26) | ||
| * Initial Release | ||
|
|
||
| ### Resource Management - Web 2.0.0 [Changelog](https://github.com/Azure/azure-sdk-for-python/blob/azure-mgmt-web_2.0.0/sdk/appservice/azure-mgmt-web/CHANGELOG.md#200-2021-02-25) |
There was a problem hiding this comment.
We should try and decide if we want all the mgmt libraries to also show up in these release notes. I think they have mostly been excluded up to this point.
There was a problem hiding this comment.
@nickzhums do you guys want start pulling in release notes from the mgmt libraries? If so we should figure out how we get them formatted so we only pull in highlights and not a huge long list like this.
There was a problem hiding this comment.
@weshaggard yes, that'd be great. What do you want me to provide ? For past release notes that we entered manually, it's usually sth like this
Management Libraries preview releases
- Service name A
- Service name b
Management Libraries GA releases
- Service name A
- Service name b
There was a problem hiding this comment.
We don't have anything supported yet but we were thinking about allowing for people to declare some sort of a "Highlights" section in the changelog that we would automatically pull into our release notes. I believe the mgmt changelogs are completely generated today though so would there be any way to have the generation process add some sort of filtered highlights section? Or do you have any other ideas on how we could automatically extract the information you usually put into the notes?
There was a problem hiding this comment.
Actually currently only Python has auto-generated changelog, Java / JavaScript changelog generation is still in development, and .NET release is owned by the service team.
So for the time being, I'm thinking about just starting with the most simple stuff - like what package we have released in this month (maybe we can show if it's an upgrade from existing SDK, or an entirely new SDK), The only thing is that mgmt libraries have lots of services so it might contain a long list. What are your thoughts on this?
There was a problem hiding this comment.
I think we should try starting with a list of preview and GA services as per Nick's comment above:
Management Libraries preview releases
Service name A
Service name b
Management Libraries GA releases
Service name A
Service name b
There was a problem hiding this comment.
Maybe for management libraries we can just link to the changelog rather that pulling the entire release (highlights), as well as listing the packages released as suggested above.
There was a problem hiding this comment.
Lets just keep them as is for the automation for now. We can re-evaluate as we start to see more patterns.
There was a problem hiding this comment.
I like @chidozieononiwu 's suggestion. Can we do that for the April release?
There was a problem hiding this comment.
Do we want to do that for all the packages? I want to try and avoid special cases if possible. We could switch all packages to be a link the the correct change log and then that is all that we get until we have guidelines for other release highlights at which time we could pull those in.
releases/2021-03/python.md
Outdated
| azure-eventgrid:2.0.0 | ||
| azure-synapse-monitoring:0.2.0 | ||
| azure-identity:1.6.0b2 | ||
| azure-synapse-managedprivateendpoints:0.3.0 |
There was a problem hiding this comment.
Can we group similar packages together? e.g. synapse family.
There was a problem hiding this comment.
We currently group them by the order in which they shipped so that we can avoid merge issues. However if you would like a special grouping you can always manually push a commit to this PR with the change. As we start to see patterns we can figure out a way to automate it.
releases/2021-03/python.md
Outdated
| - Resource Management - Resources | ||
| - Resource Management - Cosmos DB | ||
| - Resource Management - Container Service | ||
| - Core |
There was a problem hiding this comment.
We don't want to list core here
There was a problem hiding this comment.
Why don't we want to list core? We list it in other places so I'd list it here as well. If there is a good reason to not list then please submit a commit to this PR to remove it but honestly I'd like to not treat it special.
There was a problem hiding this comment.
I know that we order the packages by time, but in a customer facing aspect, it might make more sense to group storage packages together like
Storage - Files Data Lake
Storage - Blobs
then all the management packages
we might not need to do it in this release but hope this can be done sometime in the future
There was a problem hiding this comment.
Ordering is definitely an interesting consideration that we can probably come up with a way to solve. Before we publish this PR we can manually update the ordering.
@chidozieononiwu can you please file an issue about sorting the package lists? We will have to rethink things a little because if we sort them each iteration it will essentially throw out any manual edits but perhaps that is ok for these lists.
There was a problem hiding this comment.
If we update the guideline to be that all manual edits are made as suggestions that are only merged once approved by the release driver and just before the final merge of the PR then maybe we won't have conflicts between sorting and manual edits.
There was a problem hiding this comment.
Am using this issue to track all the requested changes/features.
releases/2021-03/python.md
Outdated
| $> pip install azure-keyvault-keys==4.4.0b1 | ||
| $> pip install azure-keyvault-keys==4.4.0b2 | ||
| $> pip install azure-mgmt-containerservice==15.0.0 | ||
| $> pip install azure-core==1.12.0 |
There was a problem hiding this comment.
Same, we don't expect to install core explicitly.
There was a problem hiding this comment.
I suspect that might be true for other packages as well but does it hurt to list it out?
There was a problem hiding this comment.
Do we want to explicitly filter out core package?
There was a problem hiding this comment.
No I don't want to special case just the core package. If we end up wanting to filter out some set of packages we should come up with a generic mechanism but for now I don't think we should filter core.
|
left one comment, everything else looks good |
Add ACS Release Notes
Update review comments
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
releases/2021-03/python.md
Outdated
| - Resource Management - Container Service | ||
| - Resource Management - Resources | ||
| - Resource Management - Web | ||
| - Event Grid |
There was a problem hiding this comment.
@xiangyan99 didn't we want to list Event Hubs first?
There was a problem hiding this comment.
We released event hub 5.3.1 (last one was 5.3.0) so I listed them in updates rather than GA.
There was a problem hiding this comment.
I guess you may be talking about event grid. Good catch. I will fix it.
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Co-authored-by: Cala Zubair <[email protected]>
Please use this PR for 2021-03 Python release notes update. Follow the guidelines below.
Release manager should remove all entries for packages that should not be in this release period.
Release Highlights,Installation Instructionsas well as theUpdates,Betaor,GAsection as the case may be.<!-- -->as that will cause the automation to re-add the entry on the next run.Release Highlightssections 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).
[pattern.beta]: # (- ${PackageFriendlyName})Leave feedback letting us know what group of packages should be kept out of the releases as well as any other issues you notice.