Skip to content

Clean up JSON source gen APIs - #54527

Merged
layomia merged 3 commits into
dotnet:mainfrom
layomia:SrcGenApiChanges
Jun 25, 2021
Merged

Clean up JSON source gen APIs#54527
layomia merged 3 commits into
dotnet:mainfrom
layomia:SrcGenApiChanges

Conversation

@layomia

@layomialayomia commented Jun 21, 2021

Copy link
Copy Markdown
Contributor

Addresses misc feedback about the source gen APIs. I plan to merge this PR now, then batch the API diff with upcoming additional changes (to address various to-dos from #45448). I'll take the changes to API review before preview 7.

FYI @pranavkm

@layomialayomia added this to the 6.0.0 milestone Jun 21, 2021
@layomialayomia self-assigned this Jun 21, 2021
@layomia
layomia requested a review from jozkee as a code ownerJune 21, 2021 23:22
@ghost

ghost commented Jun 21, 2021

Copy link
Copy Markdown

Tagging subscribers to this area: @eiriktsarpalis, @layomia
See info in area-owners.md if you want to be subscribed.

Issue Details

Addresses misc feedback about the source gen APIs. I plan to merge this PR now, then batch the API diff with upcoming additional changes (to address various to-dos from #45448). I'll take the changes to API review before preview 7.

FYI @pranavkm

Author:layomia
Assignees:layomia
Labels:

area-System.Text.Json

Milestone:6.0.0

@ghost

ghost commented Jun 21, 2021

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@layomialayomia mentioned this pull request Jun 21, 2021
Merged
layomia
layomia commented Jun 21, 2021
View reviewed changes
Comment threadsrc/libraries/System.Text.Json/Common/JsonSourceGenerationOptionsAttribute.cs Outdated
@layomialayomia added the breaking-change Issue or PR that represents a breaking API or functional change over a previous release. label Jun 21, 2021
@ghostghost added the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label Jun 21, 2021
@ghost

ghost commented Jun 21, 2021

Copy link
Copy Markdown

Tagging @dotnet/compat for awareness of the breaking change.

eerhardt
eerhardt reviewed Jun 22, 2021
View reviewed changes
Comment threadsrc/libraries/System.Text.Json/ref/System.Text.Json.cs Outdated
eerhardt
eerhardt reviewed Jun 22, 2021
View reviewed changes
Comment threadsrc/libraries/System.Text.Json/ref/System.Text.Json.cs
eerhardt
eerhardt reviewed Jun 22, 2021
View reviewed changes
Comment threadsrc/libraries/System.Text.Json/Common/JsonSourceGenerationOptionsAttribute.cs Outdated
eerhardt
eerhardt reviewed Jun 22, 2021
View reviewed changes
Comment threadsrc/libraries/System.Text.Json/gen/JsonSourceGenerator.Parser.cs Outdated
steveharter
steveharter reviewed Jun 22, 2021
View reviewed changes
Comment threadsrc/libraries/System.Text.Json/gen/JsonSourceGenerator.Parser.cs
steveharter
steveharter reviewed Jun 22, 2021
View reviewed changes
Comment threadsrc/libraries/System.Text.Json/gen/JsonSourceGenerator.Parser.cs
eerhardt
eerhardt approved these changes Jun 25, 2021
View reviewed changes

@eerhardteerhardt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Thanks for the cleanup!

@ghost

ghost commented Jun 25, 2021

Copy link
Copy Markdown

Hello @layomia!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@layomia

layomia commented Jun 25, 2021

Copy link
Copy Markdown
ContributorAuthor

Test failures are unrelated.

@layomia
layomia merged commit 118c530 into dotnet:mainJun 25, 2021
@layomia
layomia deleted the SrcGenApiChanges branch June 26, 2021 23:03
@halter73halter73 mentioned this pull request Jun 28, 2021
Merged
@KalleOlaviNiemitaloKalleOlaviNiemitalo mentioned this pull request Jul 24, 2021
Closed
@ghostghost locked as resolved and limited conversation to collaborators Jul 27, 2021
@gewarren

gewarren commented Aug 13, 2021

Copy link
Copy Markdown
Contributor

It looks like this needs a breaking change issue for Preview 7, if I'm reading it correctly.

@layomia

layomia commented Nov 2, 2021

Copy link
Copy Markdown
ContributorAuthor

These breaking changes have already hit customers & the APIs have changed further since then - dotnet/docs#26200.

@layomialayomia removed the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label Nov 2, 2021
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@eerhardteerhardteerhardt approved these changes
@eiriktsarpaliseiriktsarpalisAwaiting requested review from eiriktsarpalis
@jozkeejozkeeAwaiting requested review from jozkee
+1 more reviewer
@steveharterstevehartersteveharter approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@layomialayomia

Labels

area-System.Text.Jsonbreaking-changeIssue or PR that represents a breaking API or functional change over a previous release.new-api-needs-documentation

Projects

None yet

Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@layomia@gewarren@steveharter@eerhardt