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

Add parameter to listContributors for anonymous contributors #1907

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

augustd
Copy link

@augustd augustd commented Aug 9, 2024

Fixes #1905

Description

Before submitting a PR:

  • [ X] 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.
  • [X ] Add JavaDocs and other comments explaining the behavior.
  • [X ] When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • [ X] 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.
  • [X ] 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 changed the title Add listContributors method parameter to determine whether to include… Add parameter to listContributors for anonymous contributors Sep 6, 2024
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.

Please fix CI failures

@@ -3080,6 +3080,26 @@ public PagedIterable<Contributor> listContributors() throws IOException {
return root().createRequest().withUrlPath(getApiTailUrl("contributors")).toIterable(Contributor[].class, null);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
return root().createRequest().withUrlPath(getApiTailUrl("contributors")).toIterable(Contributor[].class, null);
return listContributors(null);

Comment on lines +3093 to +3100
public PagedIterable<Contributor> listContributors(boolean includeAnonymous) throws IOException {
if (includeAnonymous) {
return root().createRequest()
.withUrlPath(getApiTailUrl("contributors"))
.with("anon", "true")
.toIterable(Contributor[].class, null);
}
return listContributors();
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
public PagedIterable<Contributor> listContributors(boolean includeAnonymous) throws IOException {
if (includeAnonymous) {
return root().createRequest()
.withUrlPath(getApiTailUrl("contributors"))
.with("anon", "true")
.toIterable(Contributor[].class, null);
}
return listContributors();
public PagedIterable<Contributor> listContributors(Boolean includeAnonymous) throws IOException {
return root().createRequest()
.withUrlPath(getApiTailUrl("contributors"))
.with("anon", includeAnonymous)
.toIterable(Contributor[].class, null);

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.

List Anonymous Repository Contributors
2 participants