> 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.

Nexus Platform Plugin

View this plugin on the Plugins site

nexusPolicyEvaluation: Invoke Nexus Policy Evaluation

  • iqStage
    Controls the stage the policy evaluation will be run against on the Nexus IQ Server.
    • Type: String
  • iqInstanceId (optional)
    • Type: String
  • advancedProperties (optional)
    Provide advanced properties to the IQ Server in <key>=<value> pairs, with each additional property appearing on a new line. eg:
    key1=value1
    key2=value2
    • Type: String
  • enableDebugLogging (optional)
    • Type: boolean
  • failBuildOnNetworkError (optional)
    Controls the build outcome if there is a failure in communicating with the Nexus IQ Server (e.g. network outage). If checked, the build will be marked as failed. Otherwise, the build is only marked as unstable.
    • Type: boolean
  • iqApplication (optional)
    • Type: Object
  • iqModuleExcludes (optional)
    A comma-separated list of Ant-style patterns relative to the workspace root that denote the module information files (**/nexus-iq/module.xml) to be ignored, e.g. **/my-module/target/**, **/another-module/target/**. If unspecified all modules will contribute dependency information (if any) to the scan.
      Array / List of Nested Object
    • moduleExclude
    • moduleExclude
      • Type: String
  • iqScanPatterns (optional)
    A list of Ant-style patterns relative to the workspace root that denote the files/archives to be scanned, e.g. **/target/*.war or **/target/*.ear. If unspecified, the scan will default to the patterns **/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
      Array / List of Nested Object
    • scanPattern
    • scanPattern
      • Type: String
  • jobCredentialsId (optional)
    To use the IQ server credentials configured in Nexus global configuration for this job select - none -, otherwise select different credentials.
    • Type: String

nexusPublisher: Nexus Repository Manager Publisher

  • nexusInstanceId
    • Type: String
  • nexusRepositoryId
    The publisher currently supports hosted release Maven 2 repositories. This list is limited to repositories which meet this requirement.
    • Type: String
  • packages
      Array / List of Nested Choice of Objects
    • $class: 'MavenPackage'
    • $class: 'MavenPackage'
      • mavenCoordinate
          Nested Object
        • groupId
        • groupId
          • Type: String
        • artifactId
        • artifactId
          • Type: String
        • version
        • version
          • Type: String
        • packaging
        • packaging
          • Type: String
      • mavenAssetList
          Array / List of Nested Object
        • filePath
        • filePath
          • Type: String
        • classifier
        • classifier
          • Type: String
        • extension
        • extension
          • Type: String
  • tagName (optional)
    Tag is only available for Nexus Repository Manager 3+
    • Type: String

associateTag: Associate Tag (Nexus Repository Manager 3.x)

  • nexusInstanceId
    • Type: String
  • tagName
    The tag which will be applied to components matching the specified search criteria
    • Type: String
  • search
    The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
      Array / List of Nested Object
    • key
    • key
      • Type: String
    • value
    • value
      • Type: String

createTag: Create Tag (Nexus Repository Manager 3.x)

  • nexusInstanceId
    • Type: String
  • tagName
    Tag name is required and must be unique. Name can only contain letters, numbers, underscores, hyphens and dots and cannot start with an underscore or dot. The name cannot exceed 256 characters
    • Type: String
  • tagAttributesJson (optional)
    Optional metadata for the tag in JSON format. These attributes will be merged with those contained in the attributes file if both are provided. Attributes in this field will override those present in the file
    • Type: String
  • tagAttributesPath (optional)
    The file path (environment-aware) to the optional metadata for the tag, using the workspace as the base path
    • Type: String

deleteComponents: Delete Components (Nexus Repository Manager 3.x)

  • nexusInstanceId
    • Type: String
  • tagName
    Components associated with this tag will be deleted
    • Type: String

moveComponents: Move Components (Nexus Repository Manager 3.x)

  • nexusInstanceId
    • Type: String
  • destination
    The repository to which components will be moved
    • Type: String
  • search (optional)
    • Type: java.util.Map<java.lang.String, java.lang.String>
  • tagName (optional)
    Components associated with this tag will be moved to the selected destination repository
    • Type: String

step([$class: 'NexusPublisherBuildStep']): Nexus Repository Manager Publisher

  • nexusInstanceId
    • Type: String
  • nexusRepositoryId
    The publisher currently supports hosted release Maven 2 repositories. This list is limited to repositories which meet this requirement.
    • Type: String
  • packages
      Array / List of Nested Choice of Objects
    • $class: 'MavenPackage'
    • $class: 'MavenPackage'
      • mavenCoordinate
          Nested Object
        • groupId
        • groupId
          • Type: String
        • artifactId
        • artifactId
          • Type: String
        • version
        • version
          • Type: String
        • packaging
        • packaging
          • Type: String
      • mavenAssetList
          Array / List of Nested Object
        • filePath
        • filePath
          • Type: String
        • classifier
        • classifier
          • Type: String
        • extension
        • extension
          • Type: String
  • tagName (optional)
    Tag is only available for Nexus Repository Manager 3+
    • 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.