feat: expose fields & extend content builder with commiter and author (#28)

aszarama · web-flow · commit 637734218e7b · 2025-01-10T16:32:13.000+01:00
* feat: expose fields &amp; extend content builder with commiter and author

* fix: annotations
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.322</version>
+  <version>1.323</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/GHCommit.java b/src/main/java/org/kohsuke/github/GHCommit.java
@@ -243,11 +243,11 @@ public String getSha() {
     public static class Parent {
 
         /** The url. */
-        @SuppressFBWarnings(value = "UUF_UNUSED_FIELD", justification = "We don't provide it in API now")
-        String url;
+        @SuppressFBWarnings(value = "UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD", justification = "used in backend code")
+        public String url;
 
         /** The sha. */
-        String sha;
+        public String sha;
     }
 
     /**
diff --git a/src/main/java/org/kohsuke/github/GHContentBuilder.java b/src/main/java/org/kohsuke/github/GHContentBuilder.java
@@ -19,6 +19,16 @@ public final class GHContentBuilder {
     private final Requester req;
     private String path;
 
+    private static final class UserInfo {
+        private final String name;
+        private final String email;
+
+        private UserInfo(String name, String email) {
+            this.name = name;
+            this.email = email;
+        }
+    }
+
     /**
      * Instantiates a new GH content builder.
      *
@@ -102,6 +112,34 @@ public GHContentBuilder message(String commitMessage) {
         return this;
     }
 
+    /**
+     * Configures the author of this content.
+     *
+     * @param name
+     *            the name
+     * @param email
+     *            the email
+     * @return the gh commit builder
+     */
+    public GHContentBuilder author(String name, String email) {
+        req.with("author", new UserInfo(name, email));
+        return this;
+    }
+
+    /**
+     * Configures the committer of this content.
+     *
+     * @param name
+     *            the name
+     * @param email
+     *            the email
+     * @return the gh commit builder
+     */
+    public GHContentBuilder committer(String name, String email) {
+        req.with("committer", new UserInfo(name, email));
+        return this;
+    }
+
     /**
      * Commits a new content.
      *
diff --git a/src/main/java/org/kohsuke/github/GitCommit.java b/src/main/java/org/kohsuke/github/GitCommit.java
@@ -241,7 +241,7 @@ public String getTreeUrl() {
      * @return the parents
      */
     @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "acceptable")
-    List<GHCommit.Parent> getParents() {
+    public List<GHCommit.Parent> getParents() {
         return parents;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ public String getTreeUrl() {`
`241`	`241`	`* @return the parents`
`242`	`242`	`*/`
`243`	`243`	`@SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = "acceptable")`
`244`		`- List<GHCommit.Parent> getParents() {`
	`244`	`+ public List<GHCommit.Parent> getParents() {`
`245`	`245`	`return parents;`
`246`	`246`	`}`
`247`	`247`