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

DataProtection Configuration references the wrong libraries #19770

Closed
2 tasks
markmcgookin opened this issue Sep 3, 2020 · 5 comments · Fixed by #19771
Closed
2 tasks

DataProtection Configuration references the wrong libraries #19770

markmcgookin opened this issue Sep 3, 2020 · 5 comments · Fixed by #19771
Labels
doc-enhancement Pri1 High priority, do before Pri2 and Pri3

Comments

@markmcgookin
Copy link
Contributor

Issue description

The configuration document for DataProtection references the incorrect packages, which include issues requiring awkward workarounds.

I'll create a PR to change

Microsoft.AspNetCore.DataProtection.AzureStorage
Microsoft.AspNetCore.DataProtection.AzureKeyVault

to

Azure.Extensions.AspNetCore.DataProtection.Blobs
Azure.Extensions.AspNetCore.DataProtection.Keys

Software versions

Check the .NET target framework(s) being used, and include the version number(s).

  • [x ] .NET Core - 3.1
  • .NET Framework
  • .NET Standard
@guardrex
Copy link
Collaborator

guardrex commented Sep 3, 2020

Hello @markmcgookin ... thanks for offering to help.

Cross-ref to the announcement discussion issue: dotnet/aspnetcore#19570

@pakrym ... Do we have breaking change concerns WRT any dependencies in the 2.1/3.1 frameworks depending on the old packages, or can @markmcgookin just perform a find-'n-replace in the docs to update the packages and versions?

@guardrex guardrex added doc-enhancement needs-more-info Pri1 High priority, do before Pri2 and Pri3 and removed ⌚ Not Triaged labels Sep 3, 2020
@guardrex guardrex added this to To do in September 2020 via automation Sep 3, 2020
@guardrex guardrex added this to the 2020 Q3 ends Sept 30 milestone Sep 3, 2020
@markmcgookin
Copy link
Contributor Author

markmcgookin commented Sep 3, 2020 via email

@pakrym
Copy link
Contributor

pakrym commented Sep 3, 2020

@pakrym ... Do we have breaking change concerns WRT any dependencies in the 2.1/3.1 frameworks depending on the old packages, or can @markmcgookin just perform a find-'n-replace in the docs to update the packages and versions?

Not sure I understand the possible concern.

@guardrex
Copy link
Collaborator

guardrex commented Sep 3, 2020

These are new packages that bring in a new version of the Azure SDK which includes breaking changes. The general usage patterns are the same as the existing packages, but some overloads and options may be different (in order to react to the changes to the underlying Azure SDK APIs).

Just making sure that if someone goes to use these new packages in a 2.x/3.x app that they won't hit these breaking changes (whatever they may be ... overloads, options, etc.) without us saying anything to them. Perhaps, a remark like that ☝️ is all we need if there is any potential concern about devs only changing the the packages and going straight into production with their updated apps.

The docs question boils down to: In spite of the new packages being supported for 2.x/3.x, should these new packages be versioned in the docs and doc samples for any reason?

@pakrym
Copy link
Contributor

pakrym commented Sep 3, 2020

Thank you for the explanation @guardrex!

No, there are no concerns, for anyone 2.1 up. These packages target 2.1 of Extensions and only OOB BCL packages. They would cause some ASP.NET Core package updates for 2.0 customers but even that shouldn't be a problem, compat bar between 2.0 and 2.1 was pretty high.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Pri1 High priority, do before Pri2 and Pri3
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

4 participants