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

chore: Enable RevApi for api checking #1397

Closed
wants to merge 1 commit into from

Conversation

bitwiseman
Copy link
Member

Description

RevApi should automate reporting of API breaking changes. If someone proposes a binary breaking change, the build will fail.

Before submitting a PR:

  • Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • Add JavaDocs and other comments as appropriate. Consider including links in comments to relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • Enable "Allow edits from maintainers".

@codecov
Copy link

codecov bot commented Mar 7, 2022

Codecov Report

Merging #1397 (54a50d6) into main (694b33b) will not change coverage.
The diff coverage is n/a.

❗ Current head 54a50d6 differs from pull request most recent head fc9a80a. Consider uploading reports for the commit fc9a80a to get more accurate results

Impacted file tree graph

@@            Coverage Diff            @@
##               main    #1397   +/-   ##
=========================================
  Coverage     78.11%   78.11%           
  Complexity     2047     2047           
=========================================
  Files           200      200           
  Lines          6274     6274           
  Branches        355      355           
=========================================
  Hits           4901     4901           
  Misses         1165     1165           
  Partials        208      208           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 694b33b...fc9a80a. Read the comment docs.

This tool should automate reporting of API breaking changes. If someone proposes a binary breaking change, the build will fail.
@gsmet
Copy link
Contributor

gsmet commented Mar 7, 2022

I see you're tired of us breaking the API ;)

@bitwiseman
Copy link
Member Author

bitwiseman commented Mar 7, 2022

@gsmet I'm tired of having to tell people their change would break binary compatibility. :)
I'm tired of having to think about it.
I found a simpler tool (JAPICmp) that does the exact check that I want. Merged in #1398 .

@bitwiseman bitwiseman closed this Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants