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

Enable API stability for 2.x release train #1937

Merged
merged 1 commit into from
Sep 15, 2024

Conversation

bitwiseman
Copy link
Member

@bitwiseman bitwiseman commented Sep 15, 2024

Description

Prevent further breaking changes. If we find there is a need to make more during alpha, we can disable this check temporarily.

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 explaining the behavior.
  • When adding or updating methods that fetch entities, add @link JavaDoc entries to the 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. If not including links, explain why not.
  • 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".

@bitwiseman bitwiseman force-pushed the feature/alpha-2 branch 2 times, most recently from 4534f1a to 521e905 Compare September 15, 2024 10:13
@bitwiseman bitwiseman changed the title Initial updates for 2.x release train Enable API stability for 2.x release train Sep 15, 2024
Copy link

codecov bot commented Sep 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.61%. Comparing base (357ee37) to head (4bdc346).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1937   +/-   ##
=========================================
  Coverage     82.61%   82.61%           
  Complexity     2323     2323           
=========================================
  Files           231      231           
  Lines          6977     6977           
  Branches        376      376           
=========================================
  Hits           5764     5764           
  Misses          975      975           
  Partials        238      238           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bitwiseman bitwiseman merged commit 7807501 into hub4j:main Sep 15, 2024
12 checks passed
@bitwiseman bitwiseman deleted the feature/alpha-2 branch September 15, 2024 19:11
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.

1 participant