Update BREAKINGCHANGES.md to Include Web Cmdlets Breaking Changes #5852

Merged
merged 3 commits into from Jan 13, 2018

Conversation

Projects
None yet
3 participants
Collaborator

markekraus commented Jan 10, 2018

PR Summary

Document breaking changes in the Web Cmdlets due to switching .NET APIs and lack of IE interop.

WIP until I verify .spelling.

Reference ##5620

PR Checklist

Note: Please mark anything not applicable to this PR NA.

@markekraus markekraus requested review from joeyaiello and SteveL-MSFT Jan 10, 2018

@markekraus markekraus changed the title from WIP: Update BREAKINGCHANGES.md to Include Web Cmdlets Breaking Changes to Update BREAKINGCHANGES.md to Include Web Cmdlets Breaking Changes Jan 11, 2018

docs/BREAKINGCHANGES.md
+
+### Changes to Web Cmdlets
+
+The underlying .NET API of the Web Cmdlets has been changed to `System.Net.Http.HttpClient`. This change provides many benefits.
@SteveL-MSFT

SteveL-MSFT Jan 11, 2018

Owner

I think the end of the first sentence should be:
due to differences between .Net and CoreFx.

@iSazonov

iSazonov Jan 11, 2018

Collaborator

Maybe - .Net Framework and .Net Core.

@markekraus

markekraus Jan 11, 2018

Collaborator

But that change actually doesn't have anything to do with .NET Core and .NET Framework? Unless I'm mistaken, WebRequest still exists in .NET Core. The decision to move to HttpClient appeared to be more about performance, code simplification, and it being a better fit for these cmdlets and nothing about any particular .NET Core limitations.

As for semantic line breaks.. after reading that document I have no clue what I need to do there. Sentences on separate lines?

@SteveL-MSFT

SteveL-MSFT Jan 12, 2018

Owner

@markekraus when the webcmdlets were initially ported, only dotnetcore 1.x was available and only HttpClient was available. This has changed with dotnetcore 2.0 and we didn't go back and revert the code change (remember we only moved to dotnetcore 2.0 for RC1). Maybe it doesn't matter to bring up history since it's no longer applicable.

@markekraus

markekraus Jan 12, 2018

Collaborator

Ok, good to know. What should I say here then?

@iSazonov

iSazonov Jan 12, 2018

Collaborator

remember we only moved to dotnetcore 2.0 for RC1

Move to the official .NET Core 2.0 #4603 - august 2017.
Move powershell to .NET Core 2.0 (preview) #3556 - april 2017.

@SteveL-MSFT

SteveL-MSFT Jan 12, 2018

Owner

Sorry, meant beta

@SteveL-MSFT

SteveL-MSFT Jan 12, 2018

Owner

@markekraus upon reflection, let's just leave it the way you wrote it except add a line break :)

@markekraus

markekraus Jan 12, 2018

Collaborator

fixed.

@iSazonov iSazonov self-assigned this Jan 11, 2018

@iSazonov iSazonov merged commit 3e9a530 into PowerShell:master Jan 13, 2018

4 checks passed

WIP ready for review
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
license/cla All CLA requirements met.
Details

@markekraus markekraus deleted the markekraus:DocumentWebCmdletsBreakingChanges branch Jan 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment