The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

IBM Cloud DevOps

View this plugin on the Plugins site

evaluateGate: IBM Cloud DevOps Gate

  • policy : String
  • applicationName : String (optional)
  • buildNumber : String (optional)
  • credentialsId : String (optional)
  • environment : String (optional)
  • forceDecision : String (optional)
  • orgName : String (optional)
  • toolchainId : String (optional)

notifyOTC: Send notification to OTC

  • stageName : String
  • status : String
  • webhookUrl : String (optional)

publishBuildRecord: Publish build record to IBM Cloud DevOps

  • result : String
  • gitRepo : String
  • gitBranch : String
  • gitCommit : String
  • applicationName : String (optional)
  • buildNumber : String (optional)
  • credentialsId : String (optional)
  • orgName : String (optional)
  • toolchainId : String (optional)

publishDeployRecord: Publish deploy record to IBM Cloud DevOps

  • result : String
  • environment : String
  • appUrl : String (optional)
  • applicationName : String (optional)
  • buildNumber : String (optional)
  • credentialsId : String (optional)
  • orgName : String (optional)
  • toolchainId : String (optional)

publishSQResults: Publish SonarQube test results to IBM Cloud DevOps

  • SQHostURL : String (optional)
  • SQAuthToken : String (optional)
  • SQProjectKey : String (optional)
  • applicationName : String (optional)
  • buildNumber : String (optional)
  • credentialsId : String (optional)
  • environment : String (optional)
  • orgName : String (optional)
  • toolchainId : String (optional)

publishTestResult: Publish test result to IBM Cloud DevOps

  • type : String
  • fileLocation : String
  • applicationName : String (optional)
  • buildNumber : String (optional)
  • credentialsId : String (optional)
  • environment : String (optional)
  • orgName : String (optional)
  • toolchainId : String (optional)

sendDeployableMessage: Send deployable mapping message to OTC

  • status : String
  • webhookUrl : String (optional)

step([$class: 'EvaluateGate']): IBM Cloud DevOps Gate

  • policyName : String
    Select the policy that you want this gate to enforce. You can create more policies in DevOps Insights.
  • toolchainName : String
    Select a toolchain. If you have not created a toolchain yet, create one here.
  • buildJobName : String
    Enter the name of the build job that triggers this test job. You can use an environment variable, such as $BUILD_JOB.
  • credentialsId : String
    Select an API Key from the menu. If no API Key are in the menu, click Add to add one. Click Test Connection to verify the selected credentials. The use of Username/Password will be deprecated soon
  • willDisrupt : boolean
    Select this check box to cancel associated Jenkins builds when this gate fails.
  • scope
      Nested Object
    • value : String
    • branchName : String
    • envName : String
  • additionalBuildInfo
    Select this check box if the deployed app is not built in Jenkins.
      Nested Object
    • buildNumber : String
    • buildUrl : String
  • applicationName : String (optional)
    Type a name for the application that information is being uploaded for. Use this application name when you configure DevOps Insights gates. You can use an environment variable, such as $APP_NAME.

step([$class: 'PublishBuild']): Publish build information to IBM Cloud DevOps

  • additionalBuildInfo
    Select this check box if you want to set your own build number.
      Nested Object
    • buildNumber : String
    • buildUrl : String
  • applicationName : String (optional)
    Type a name for the application that information is being uploaded for. Use this application name when you configure DevOps Insights gates. You can use an environment variable, such as $APP_NAME.
  • credentialsId : String (optional)
    Select an API Key from the menu. If no API Key are in the menu, click Add to add one. Click Test Connection to verify the selected credentials. The use of Username/Password will be deprecated soon
  • toolchainName : String (optional)
    Type the ID of your toolchain. If you have not created a toolchain yet, create one here.
  • orgName : String (optional)

step([$class: 'PublishDeploy']): Publish deployment information to IBM Cloud DevOps

  • toolchainName : String
    Type the ID of your toolchain. If you have not created a toolchain yet, create one here.
  • buildJobName : String
    Enter the name of the build job that triggers this test job. You can use an environment variable, such as $BUILD_JOB.
  • environmentName : String
    Type the name of the environment that this job deploys to. If this environment is your staging environment, type "STAGING." If this environment is your production requirement, type "PRODUCTION." If you do not specify staging and production environments, DevOps Insights cannot completely analyze your project.
  • credentialsId : String
    Select an API Key from the menu. If no API Key are in the menu, click Add to add one. Click Test Connection to verify the selected credentials. The use of Username/Password will be deprecated soon
  • applicationUrl : String
    Optional: If this is a web application, enter its URL. You can use an environment variable, such as $APP_URL.
  • additionalBuildInfo
    Select this check box if you want to set your own build number
      Nested Object
    • buildNumber : String
  • applicationName : String (optional)
    Type a name for the application that information is being uploaded for. Use this application name when you configure DevOps Insights gates. You can use an environment variable, such as $APP_NAME.

step([$class: 'PublishSQ']): Publish SonarQube test result to IBM Cloud DevOps

  • credentialsId : String
    Select an API Key from the menu. If no API Key are in the menu, click Add to add one. Click Test Connection to verify the selected credentials. The use of Username/Password will be deprecated soon
  • toolchainName : String
    Select a toolchain. If you have not created a toolchain yet, create one here.
  • buildJobName : String
    Enter the name of the build job that triggers this test job. You can use an environment variable, such as $BUILD_JOB.
  • SQHostName : String
    Type the hostname of the server that your SonarQube instance runs on. Do not enter a trailing slash.
  • SQAuthToken : String
    Enter your API token that SonarQube generated for you.
  • SQProjectKey : String
    Type the key of the SonarQube project that you wish to scan.
  • additionalBuildInfo
    Select this check box if you want to set your own build number
      Nested Object
    • buildNumber : String
  • applicationName : String (optional)
    Type a name for the application that information is being uploaded for. Use this application name when you configure DevOps Insights gates. You can use an environment variable, such as $APP_NAME.

step([$class: 'PublishTest']): Publish test result to IBM Cloud DevOps

  • lifecycleStage : String
    Select the type of test. Your tests must correspond to rules in policies.
      Supported formats:
    • Code coverage: Istanbul, BlanketJS
    • Unit and functional verification tests: Mocha, xUnit, and Karma Mocha
  • contents : String
    Enter the test result file location relative to the root directory. The result file must contain results in the format that you selected for the metric type. This field supports wildcards and environment variables. If you leave this field empty, DevOps Insights generates a simple test report that is based on job status. Mocha, KarmaMocha, Istanbul, and BlanketJS test results must be in the JSON format. xUnit test results must be in the XML format.
  • toolchainName : String
    Select a toolchain. If you have not created a toolchain yet, create one here.
  • buildJobName : String
    Enter the name of the build job that triggers this test job. You can use an environment variable, such as $BUILD_JOB.
  • credentialsId : String
    Select an API Key from the menu. If no API Key are in the menu, click Add to add one. Click Test Connection to verify the selected credentials. The use of Username/Password will be deprecated soon
  • additionalUpload
    Optional: You can upload another test result file and select another metric type in this job.
      Nested Object
    • additionalLifecycleStage : String
    • additionalContents : String
  • additionalBuildInfo
    Select this check box if you want to set your own build number
      Nested Object
    • buildNumber : String
  • additionalGate
      Nested Object
    • policyName : String
    • willDisrupt : boolean (optional)
  • testEnv
      Nested Object
    • value : String
    • branchName : String
    • envName : String
  • applicationName : String (optional)
    Type a name for the application that information is being uploaded for. Use this application name when you configure DevOps Insights gates. You can use an environment variable, such as $APP_NAME.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.