lock: Lock shared resource

• resource : String

  The resource name to lock as defined in Global settings. If the resource does not exist in Global Settings it will be automatically created on build execution. Either a resource or a label need to be specified.

• extra (optional)
  Array / List of Nested Object
  • resource : String

    The resource name to lock as defined in Global settings. If the resource does not exist in Global Settings it will be automatically created on build execution. Either a resource or a label need to be specified.

  • label : String (optional)

    The label of the resources to be locked as defined in Global settings. Either a resource or a label need to be specified.

  • quantity : int (optional)

    The quantity of resources with the specified label to be locked as defined in Global settings. Either a resource or a label need to be specified. Empty value or 0 means lock all matching resources.

• inversePrecedence : boolean (optional)

  By default waiting builds get the lock in the same order they requested to acquire it.

  By checking this option the newest build in the waiting queue will get the lock first.

• label : String (optional)

  The label of the resources to be locked as defined in Global settings. Either a resource or a label need to be specified.

• quantity : int (optional)

  The quantity of resources with the specified label to be locked as defined in Global settings. Either a resource or a label need to be specified. Empty value or 0 means lock all matching resources.

• skipIfLocked : boolean (optional)

  By default waiting builds get the lock.

  By checking this option the body will not be executed if there is a queue. It will only take the lock if it can be taken immediately.

• variable : String (optional)

  Name of an environment variable that will receive the comma separated list of the names of the locked resources while the block executes.

  e.g.:

  lock(label: 'label', variable: 'var') {
      echo "Resource locked: ${env.var}"
  }