Document the sha1 parameter

jenkinsci · Aug 3, 2024 · a5e5fcd · a5e5fcd
1 parent f00d7c3
commit a5e5fcd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/test/java/jenkins/plugins/git/GitSampleRepoRule.java b/src/test/java/jenkins/plugins/git/GitSampleRepoRule.java
@@ -120,8 +120,11 @@ public String notifyCommit(JenkinsRule r, @CheckForNull String notifyCommitToken
      * If the caller wants to pass no access token, the
      * notifyCommitToken needs to be null
      *
+     * If the caller wants to pass no SHA-1, the sha1 parameter needs to be null.
+     *
      * @param r JenkinsRule to receive the commit notification
      * @param notifyCommitToken token used for notifyCommit authentication
+     * @param sha1 SHA-1 hash to included in notifyCommit
      **/
     public String notifyCommit(JenkinsRule r, @CheckForNull String notifyCommitToken, @CheckForNull String sha1) throws Exception {
         boolean expectError = notifyCommitToken == null || notifyCommitToken.contains(INVALID_NOTIFY_COMMIT_TOKEN);