Add parameters list

Signed-off-by: Zelin Hao <[email protected]>
opensearch-project · Dec 12, 2024 · 0b52cc3 · 0b52cc3
1 parent 4752854
commit 0b52cc3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/build.gradle b/build.gradle
@@ -128,7 +128,7 @@ jacocoTestReport {
     }
 }
 
-String version = '8.0.1'
+String version = '8.1.0'
 
 task updateVersion {
     doLast {

diff --git a/vars/runSmokeTestScript.groovy b/vars/runSmokeTestScript.groovy
@@ -6,6 +6,15 @@
  * this file be licensed under the Apache-2.0 license or a
  * compatible open source license.
  */
+/**@
+ * Contains logic to execute the smoke test workflow
+ *
+ * @param args A map of the following parameters
+ * @param args.testManifest <required> Test manifest file location
+ * @param args.buildManifest <required> Build manifest file location
+ * @param args.jobName <optional> Job name that triggered the workflow. 'distribution-build-opensearh' by default.
+ * @param args.buildId <required> Build ID of the distribution artifacts
+*/
 void call(Map args = [:]) {
     String jobName = args.jobName ?: 'distribution-build-opensearch'
     lib = library(identifier: 'jenkins@main', retriever: legacySCM(scm))