From a5e5fcdedf8f6e2a91c929e652f7ec8e7b1da8cf Mon Sep 17 00:00:00 2001 From: Mark Waite Date: Sat, 3 Aug 2024 14:24:35 -0600 Subject: [PATCH] Document the sha1 parameter --- src/test/java/jenkins/plugins/git/GitSampleRepoRule.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/test/java/jenkins/plugins/git/GitSampleRepoRule.java b/src/test/java/jenkins/plugins/git/GitSampleRepoRule.java index cf81d2a052..152169719c 100644 --- 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);