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 visibility of getters in GHRequestedAction #1824

Merged
merged 1 commit into from
Mar 25, 2024

Conversation

yrodiere
Copy link
Contributor

Description

GHRequestedAction has getters, but those getters have package-private (default) visibility, and thus are unusable.

This changes the visibility of those getters to public.

Looks like this part of the API is untested, and sorry, I didn't really have time to add new tests, but I figured this at least nudges things the right way 🤷

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 self-requested a review March 22, 2024 16:30
Copy link
Member

@bitwiseman bitwiseman left a comment

Choose a reason for hiding this comment

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

Related:

The docs indicate that the requested_action field only contains identifier in the current release. I guess we can make getIdentifier() public, but it seems like making the other two public would be counterproductive.

src/main/java/org/kohsuke/github/GHRequestedAction.java Outdated Show resolved Hide resolved
src/main/java/org/kohsuke/github/GHRequestedAction.java Outdated Show resolved Hide resolved
Co-Authored-By: Liam Newman <bitwiseman@gmail.com>
@yrodiere
Copy link
Contributor Author

I applied your suggestions, thanks.

Copy link

codecov bot commented Mar 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.64%. Comparing base (092d254) to head (4bdf1fe).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1824   +/-   ##
=========================================
  Coverage     80.64%   80.64%           
  Complexity     2354     2354           
=========================================
  Files           223      223           
  Lines          7185     7185           
  Branches        395      395           
=========================================
  Hits           5794     5794           
  Misses         1145     1145           
  Partials        246      246           

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

@bitwiseman bitwiseman merged commit be680c7 into hub4j:main Mar 25, 2024
11 checks passed
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