Add Javadocs on 'newTagRevision' property

shipkit · Dec 21, 2020 · 64ef115 · 64ef115
1 parent 93a7704
commit 64ef115
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/main/java/org/shipkit/gh/release/GitHubReleaseTask.java b/src/main/java/org/shipkit/gh/release/GitHubReleaseTask.java
@@ -81,11 +81,19 @@ public void setWriteToken(String writeToken) {
         this.writeToken = writeToken;
     }
 
+    /**
+     * See {@link #setNewTagRevision(String)}
+     */
     @Input
     public String getNewTagRevision() {
         return newTagRevision;
     }
 
+    /**
+     * Property required to specify revision for the new tag.
+     * The property's value is passed to GitHub API's
+     * 'target_commitish' parameter in {@link #postRelease()} method.
+     */
     public void setNewTagRevision(String newTagRevision) {
         this.newTagRevision = newTagRevision;
     }