paginated release builder

eyalfoni · eyalfoni · commit 6fe7713fd8f7 · 2023-12-19T10:07:40.000-05:00
diff --git a/pom.xml b/pom.xml
@@ -2,7 +2,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>org.kohsuke</groupId>
   <artifactId>cortexapps-github-api</artifactId>
-  <version>1.318</version>
+  <version>1.319</version>
   <name>GitHub API for Java</name>
   <url>https://github-api.kohsuke.org/</url>
   <description>GitHub API for Java</description>
diff --git a/src/main/java/org/kohsuke/github/GHReleaseQueryBuilder.java b/src/main/java/org/kohsuke/github/GHReleaseQueryBuilder.java
@@ -0,0 +1,56 @@
+package org.kohsuke.github;
+
+/**
+ * Builds up the query for listing releases.
+ *
+ * @author eyalfoni
+ * @see GHRepository#queryReleases()
+ */
+public class GHReleaseQueryBuilder {
+    private final Requester req;
+    private final GHRepository repo;
+
+    /**
+     * Instantiates a new GH release query builder.
+     *
+     * @param repo
+     *            the repo
+     */
+    GHReleaseQueryBuilder(GHRepository repo) {
+        this.repo = repo;
+        this.req = repo.root().createRequest(); // requester to build up
+    }
+
+    /**
+     * Page gh release query builder.
+     *
+     * @param page
+     *            the page
+     * @return the gh release query builder
+     */
+    public GHReleaseQueryBuilder page(int page) {
+        req.with("page", page);
+        return this;
+    }
+
+    /**
+     * Page size gh release query builder.
+     *
+     * @param pageSize
+     *            the page size
+     * @return the gh release query builder
+     */
+    public GHReleaseQueryBuilder pageSize(int pageSize) {
+        req.with("per_page", pageSize);
+        return this;
+    }
+
+    /**
+     * Lists up the releases with the criteria built so far.
+     *
+     * @return the paged iterable
+     */
+    public PagedIterable<GHRelease> list() {
+        return req.withUrlPath(repo.getApiTailUrl("releases")).toIterable(GHRelease[].class, item -> item.wrap(repo));
+    }
+}
diff --git a/src/main/java/org/kohsuke/github/GHRepository.java b/src/main/java/org/kohsuke/github/GHRepository.java
@@ -2102,6 +2102,16 @@ public GHCommitQueryBuilder queryCommits() {
         return new GHCommitQueryBuilder(this);
     }
 
+
+    /**
+     * List releases with pagination through a builder pattern.
+     *
+     * @return the gh release query builder
+     */
+    public GHReleaseQueryBuilder queryReleases() {
+        return new GHReleaseQueryBuilder(this);
+    }
+
     /**
      * Lists up all the commit comments in this repository.
      *
