Skip to content

Implement milestone payload and query builder#2284

Open
gsmet wants to merge 1 commit into
hub4j:mainfrom
gsmet:milestone-improvements
Open

Implement milestone payload and query builder#2284
gsmet wants to merge 1 commit into
hub4j:mainfrom
gsmet:milestone-improvements

Conversation

@gsmet

@gsmet gsmet commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Description

Implement the payload for milestone... Don't know how I missed it earlier as it's quite useful.
Also allow to query the milestones with more options as it's useful to be able to sort them properly.

While a query builder is a bit heavy for what we actually need to do here, I favored a pattern we are using globally, and we never know what they might add to the API later.

I wanted to be able to sort the milestones.
Even that is extremely limited...
Believe it or not, we can't sort by close dates.

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 "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED" 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".

While a query builder is a bit heavy for what we actually need to do
here, I favored a pattern we are using globally, and we never know what
they might add to the API later.

I wanted to be able to sort the milestones.
Even that is extremely limited...
Believe it or not, we can't sort by close dates.
@gsmet

gsmet commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

hey @bitwiseman , long time no see :). I hope you're doing well.

@gsmet

gsmet commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

BTW, I should explain a bit why this is critical for us: I need to get the 20 latest milestones and currently we can't do it. Meaning that I'm forced to get the ~500 milestones we have in the Quarkus project and then filter them. And the GitHub API rate limiting is not exactly happy about it :).

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