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

Fix PublicAPI build checks #2575

Merged
merged 3 commits into from
Dec 7, 2022
Merged

Fix PublicAPI build checks #2575

merged 3 commits into from
Dec 7, 2022

Conversation

corranrogue9
Copy link
Contributor

Currently, we don't get build errors when the public API surface has changed but the corresponding PublicAPI.Unshipped.txt has not been updated. This is because we get warnings that there are duplicate entries in PublicAPI.Unshipped.txt and PublicAPI.Shipped.txt. Because the analyzer doesn't know what to do when it encounters those warnings, it doesn't go on to generate the errors that there are missing entries in the text file (effectively disabling the public API build checks).

This change upgrades those duplicate entry warnings to errors, and it also upgrades the warning that an entry exists in the text file but doesn't correspond to a public API. These two will prevent us from accidentally "disabling" the public API build checks in the future.

This change also addresses the issues in the existing PublicAPI.*.txt files, removing the duplicate entries from the Unshipped variants.

It also adds support in Core and Client for multiple target frameworks in preparation for #2433.

@pull-request-quantifier-deprecated

This PR has 105 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Medium
Size       : +73 -32
Percentile : 41%

Total files changed: 12

Change summary by file extension:
.csproj : +22 -5
.txt : +51 -27

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.


<Import Project="..\Build.props" />

<PropertyGroup Condition="'$(TreatWarningsAsErrors)' == 'false' or '$(TreatWarningsAsErrors)' == ''">
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this not belong in the ../Build.props?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We use Build.props in our test projects as well, which we don't ship publicly. I can try to consolidate the csproj elements used by our shipped projects into a .props file though if you think that makes sense.

Copy link
Member

@mikepizzo mikepizzo left a comment

Choose a reason for hiding this comment

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

:shipit:

@corranrogue9 corranrogue9 merged commit 34b0b66 into master Dec 7, 2022
@corranrogue9 corranrogue9 deleted the corranrogue9/publicapifix branch December 7, 2022 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants