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 GHIssue#queryComments, with a since() filter #1524

Merged
merged 2 commits into from
Sep 27, 2022

Conversation

yrodiere
Copy link
Contributor

@yrodiere yrodiere commented Sep 22, 2022

Description

Relevant documentation: https://docs.github.com/en/rest/issues/comments#list-issue-comments

This particular endpoint was already exposed through listComments, but that method doesn't allow setting the since filter, which filters out comments last created/updated before a given date.

I fixed that by introducing a new queryComments method that works similarly to org.kohsuke.github.GHRepository#queryIssues, though it exposes only one filter (the only one available at the moment): since.

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

Copied from GHPullRequestTest: I'm not trying to test everything here,
just to have a basic test class that I can add comment-related tests to.
@codecov
Copy link

codecov bot commented Sep 22, 2022

Codecov Report

Base: 78.95% // Head: 78.98% // Increases project coverage by +0.02% 🎉

Coverage data is based on head (a628b93) compared to base (319e943).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1524      +/-   ##
============================================
+ Coverage     78.95%   78.98%   +0.02%     
- Complexity     2129     2134       +5     
============================================
  Files           204      205       +1     
  Lines          6463     6472       +9     
  Branches        362      362              
============================================
+ Hits           5103     5112       +9     
  Misses         1148     1148              
  Partials        212      212              
Impacted Files Coverage Δ
src/main/java/org/kohsuke/github/GHIssue.java 74.05% <100.00%> (+0.16%) ⬆️
...org/kohsuke/github/GHIssueCommentQueryBuilder.java 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@bitwiseman bitwiseman merged commit ea9f4b1 into hub4j:main Sep 27, 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