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

feat: get memberships of an organisation by username #1850

Merged
merged 5 commits into from
Jun 10, 2024

Conversation

fv316
Copy link
Contributor

@fv316 fv316 commented Jun 6, 2024

Description

This PR creates a new GHOrganisation method that allows for fetching the GHMembership object from a String username. This also means that GHUser objects (inside the GHMembership object) can be fetched directly from a username instead of using the existing listMembers method.

Fixes #1849

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".

Copy link

codecov bot commented Jun 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.66%. Comparing base (c5ce1f6) to head (24105f7).
Report is 7 commits behind head on main.

Current head 24105f7 differs from pull request most recent head b74126c

Please upload reports for the commit b74126c to get more accurate results.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1850      +/-   ##
============================================
+ Coverage     80.64%   80.66%   +0.02%     
- Complexity     2358     2360       +2     
============================================
  Files           225      225              
  Lines          7203     7206       +3     
  Branches        395      395              
============================================
+ Hits           5809     5813       +4     
+ Misses         1149     1148       -1     
  Partials        245      245              

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

@bitwiseman bitwiseman merged commit 3043691 into hub4j:main Jun 10, 2024
9 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.

Add support for fetching a single organisation member by username
2 participants