Skip to content

Latest commit

 

History

History
168 lines (141 loc) · 4.2 KB

JOB_DSL.md

File metadata and controls

168 lines (141 loc) · 4.2 KB
Raw

Job DSL

The Ontrack plug-in provides the following extensions to the Job DSL.

Table of contents

Build notifier

job(...) {
   publishers {
      ontrackBuild(project, branch, buildName, ignoreFailure = false, runInfo = false)
   }
}

Promotion notifier

job(...) {
   publishers {
      ontrackPromotion(project, branch, build, promotionLevel)
   }
}

Validation notifier

job(...) {
   publishers {
      ontrackValidation(project, branch, build, validationStamp, ignoreFailure = false, runInfo = false)
   }
}

Triggers

job(...) {
    triggers {
        ontrackTrigger '0 0 H/* * *', 'project', 'branch', 'PROMOTION', 'VERSION'
    }
}

and PROMOTION can be a valid Ontrack promotion level name or

  • blank to mean the last build
  • * to mean the last promoted build

DSL notifier

job(...) {
   publishers {
      ontrackDsl {
         // Path to the DSL (relative to workspace)
         path(String value)
         // Ontrack DSL script
         script(String value)
         // Injects environment variables
         // Can be called several times
         environment(String... names)
         // Inject property values
         properties(String properties)
         // Enables or disables the log
         log(boolean enabled = true)
      }
   }
}

DSL step

job(...) {
   steps {
      ontrackDsl {
         // Path to the DSL (relative to workspace)
         path(String value)
         // Ontrack DSL script
         script(String value)
         // Injects environment variables
         // Can be called several times
         environment(String... names)
         // Inject property values
         properties(String properties)
         // Enables or disables the log
         log(boolean enabled = true)
      }
   }
}

Parameters

Single or multiple choice parameters can be created using the following steps:

job("...") {
    parameters {
        ontrackChoiceParameter {
            // Name of the environment variable to create (required)
            name "SINGLE_PARAM"
            // Description to display for the parameter (defaults to "")
            description "A single parameter"
            // Ontrack DSL script (required)
            dsl "Ontrack script to run"
            // Value to extract from the result of the script (defaults to "name")
            valueProperty "name"
            // Sandbox environment (defaults to `false`)
            sandbox()
            // Binding to use in the DSL
            binding "name1", "value"
            binding "name2", 10
            binding "name3", false
        }
    }
}
  • The ontrackSingleParameter step, with the same parameters can be used to have a single computed parameter.
  • The ontrackMultipleChoiceParameter step, with the same parameters can be used to have a multiple choice. In this case, the returned value must be a list.

Last build parameter

This definition creates a parameter which offers the selection of the last builds of a given branch.

job("...") {
    parameters {
        ontrackBuildParameter {
            // Name of the environment variable to create (required)
            name "NAME"
            // Description to display for the parameter (defaults to "Build")
            description "Select a build"
            // Project & branch
            project "my-project"
            branch "release-1.0"
            // Optional promotion filter
            promotion "IRON"
            // Use this method to specify that the returned value
            // must be the label (release property) of the build instead
            // of its name
            useLabel()
            // Number of elements to display (defaults to `10`)
            count 10
        }
    }
}

Future extensions

Future versions of the Ontrack plug-in will bring Job DSL extensions to support:

  • environment contributions