Repository navigation
AUS-1013: package-link check, API surface dumps and an upgrading note - #176
Merged
Merged
Conversation
.github/scripts/check_package_links.py <version> downloads the four packages from nuget.org, requests every absolute URL in projectUrl, the repository url, the release notes and the README, and builds a scratch project that prints the ObsoleteAttribute on the three obsolete members so each UrlFormat, formatted with its DiagnosticId, is fetched and its anchor asserted in the page. Sample addresses (localhost, 127.0.0.1, .test, example.com) in the READMEs are skipped. .github/scripts/api_surface dumps the public API of the four assemblies as sorted text; docs/api-surface holds the dumps for 2.0.0-preview.1 and 2.0.0-preview.3. The preview.3 file is the surface frozen for 2.0.0. docs/upgrading.md gains the one step the upgrade smoke test needed that the guide did not state: Newtonsoft.Json is no longer a dependency of the core, so code that handles JObject or JArray adds the Newtonsoft package and selects its serializer.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Verification of the published
2.0.0-preview.3packages and the API and wire freeze before 2.0.0 final. No library change. The four results are on the Linear ticket; this pull request carries what the checks left behind..github/scripts/check_package_links.py <version>: downloads the four packages from nuget.org, requests every absolute URL inprojectUrl, the repository url, the release notes and the README, then builds a scratch project against the core package that prints theObsoleteAttributeonHandler.RegisterFuction,Handler.UnRegisterFunctionandConfig.SetBeforeProcessHandler, formats eachUrlFormatwith itsDiagnosticId, fetches the page and asserts the anchor is in the HTML. Sample addresses in the READMEs (localhost, 127.0.0.1,.test, example.com) are skipped. Passes for preview.3: 35 URLs, three anchors, core assembly strong-named..github/scripts/api_surfaceanddocs/api-surface/: a reflection dump of the public surface of the four assemblies as sorted text, one file per published version.2.0.0-preview.3.txtis the surface frozen for 2.0.0; the final release must diff against it in the version lines only. The preview.1 to preview.3 diff is exactly what the changelog says:InProcessClientremoved,JsonRpcLimits,SetLimitsandLimitExceededInfoadded,sessionIDparameters renamedsessionId,FromMethodrenamedFromMethodInfo,RpcInterfaceMethod.MethodrenamedMethodInfo, and the public key token on every type.docs/upgrading.md: one bullet the upgrade smoke test needed that the guide did not state. Newtonsoft.Json is no longer a dependency of the core, so code that handlesJObjectorJArrayadds the Newtonsoft package and selects its serializer; without the second step the casts are silently false.Linear: AUS-1013.