> User Documentation Home

User Handbook
Tutorials
Resources

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.

PingCode Plugin

View this plugin on the Plugins site

pingcodeBuildRecord: Send build result to pingcode

  • defaultSummary (optional)
    • Type: String
  • failOnError (optional)
    • Type: boolean
  • overviewPattern (optional)
    • Type: String
  • resultURL (optional)
    • Type: String
  • status (optional)
    • Type: String

pingcodeDeployRecord: Send deploy result to pingcode

  • releaseName
    • Type: String
  • environmentName
    • Type: String
  • failOnError (optional)
    • Type: boolean
  • isTagged (optional)
    • Type: boolean
  • releaseURL (optional)
    • Type: String
  • status (optional)
    • Type: String

step([$class: 'PCBuildNotifier']): PingCode: create build record

  • overview (optional)
    A regular expression is used to match the result summary in the build output for display in PingCode.

    For example: The following is part of the build output in Jenkins:

    ...
    # utilities ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 40, true
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 39, false
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 41, false
    ✓ #PLM-1239 isSha, input ' ' + '0-9a-fA-F' * 39, false
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 39 + ' ', false
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 1 + '0-9a-fA-F ' * + '0-9a-fA-F' * 1, true

    720 passing (10s)

    If you want to display the line 720 passing (10s) on PingCode Agile Project, you need to enter ^.*passing in the input box. PingCode jenkins plugin will match this line from the build result according to your input regular expression and send it to PingCode.

    • Type: String
  • defaultSummary (optional)
    If no information can be matched from the result logs, this value will be sent by default.
    • Type: String
  • resultURL (optional)
    A url of result for display in pingcode. if empty, the jenkins console result url will be used.
    You can use environment variables for dynamic variable substitution in the url.
    For example: http://jenkins-host/result-${BUILD_ID}, which means that the url is dynamically generated using the BUILD_ID. All environment variables injected by the plugin can be used. If the environment variable does not exist, the source character will be retained.
    • Type: String

step([$class: 'PCDeployNotifier']): PingCode: create deploy record

  • tagged
    • Type: boolean
  • releaseName (optional)
    The name of the release. You can use environment variables for dynamic variable substitution in the name.
    For example: release-${BUILD_ID}, which means that the release name is dynamically generated using the BUILD_ID. All environment variables injected by the plugin can be used. If the environment variable does not exist, the source character will be retained.
    • Type: String
  • environmentName (optional)
    The name of environment that the code will be deployed to. If the environment does not exist, the plugin will automatically create.
    • Type: String
  • releaseUrl (optional)
    Optional. A URL that can view the detail deployment results. If it is empty, no related links are displayed in PingCode.
    • Type: String

step([$class: 'WTBuildNotifier']): Worktile: create build record

  • overview (optional)
    A regular expression is used to match the result summary in the build output for display in PingCode.

    For example: The following is part of the build output in Jenkins:

    ...
    # utilities ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 40, true
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 39, false
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 41, false
    ✓ #PLM-1239 isSha, input ' ' + '0-9a-fA-F' * 39, false
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 39 + ' ', false
    ✓ #PLM-1239 isSha, input '0-9a-fA-F' * 1 + '0-9a-fA-F ' * + '0-9a-fA-F' * 1, true

    720 passing (10s)

    If you want to display the line 720 passing (10s) on PingCode Agile Project, you need to enter ^.*passing in the input box. PingCode jenkins plugin will match this line from the build result according to your input regular expression and send it to PingCode.

    • Type: String
  • defaultSummary (optional)
    If no information can be matched from the result logs, this value will be sent by default.
    • Type: String
  • resultURL (optional)
    A url of result for display in pingcode. if empty, the jenkins console result url will be used.
    You can use environment variables for dynamic variable substitution in the url.
    For example: http://jenkins-host/result-${BUILD_ID}, which means that the url is dynamically generated using the BUILD_ID. All environment variables injected by the plugin can be used. If the environment variable does not exist, the source character will be retained.
    • Type: String

step([$class: 'WTDeployNotifier']): Worktile: create deploy record

  • tagged
    • Type: boolean
  • releaseName (optional)
    The name of the release. You can use environment variables for dynamic variable substitution in the name.
    For example: release-${BUILD_ID}, which means that the release name is dynamically generated using the BUILD_ID. All environment variables injected by the plugin can be used. If the environment variable does not exist, the source character will be retained.
    • Type: String
  • environmentName (optional)
    The name of environment that the code will be deployed to. If the environment does not exist, the plugin will automatically create.
    • Type: String
  • releaseUrl (optional)
    Optional. A URL that can view the detail deployment results. If it is empty, no related links are displayed in PingCode.
    • Type: String

worktileBuildRecord: Send build result to worktile

  • defaultSummary (optional)
    • Type: String
  • failOnError (optional)
    • Type: boolean
  • overviewPattern (optional)
    • Type: String
  • resultURL (optional)
    • Type: String
  • status (optional)
    • Type: String

worktileDeployRecord: Send deploy result to worktile

  • releaseName
    • Type: String
  • environmentName
    • Type: String
  • failOnError (optional)
    • Type: boolean
  • isTagged (optional)
    • Type: boolean
  • releaseURL (optional)
    • Type: String
  • status (optional)
    • Type: String

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.