Module: Jujube::Components::Scm

Extended by:
Macros
Included in:
Jujube::Components
Defined in:
lib/jujube/components/scm.rb

Overview

Helper methods for creating SCM components.

store Pundle Specifications collapse

Instance Method Summary collapse

Methods included from Macros

attribute, section

Instance Method Details

#bundle(name) ⇒ Hash

Specify a bundle to check for a #store SCM.

Parameters:

  • name (String) —

    The name of the bundle to check.

Returns:

  • (Hash) —

    The specification for the package.



55
56
57
 
# File 'lib/jujube/components/scm.rb', line 55

def bundle(name)
  {"bundle" => name}
end

#git(options = {}) ⇒ Hash

Specify a git SCM for a job.

See http://ci.openstack.org/jenkins-job-builder/publishers.html#scm.git.

Parameters:

  • options (Hash) (defaults to: {}) —

    The configuration options for the component.

Returns:

  • (Hash) —

    The specification for the component.



15
 
# File 'lib/jujube/components/scm.rb', line 15

standard_component :git

#package(name) ⇒ Hash

Specify a package to check for a #store SCM.

Parameters:

  • name (String) —

    The name of the package to check.

Returns:

  • (Hash) —

    The specification for the package.



47
48
49
 
# File 'lib/jujube/components/scm.rb', line 47

def package(name)
  {"package" => name}
end

#store(options = {}) {|pundles| ... } ⇒ Hash

Specify a store SCM for a job.

This SCM requires support in jenkins-job-builder that has not yet been merged. See https://review.openstack.org/85729 for the patch.

store can watch multiple pundles (packages or bundles) The specification for each pundle is added in a nested configuration block using the #package or #bundle method.

Examples:

job "store-example" do |j|
  j.scm << store(script: "SCRIPT", repository: "REPO") do |pundles|
    pundles << package("PACKAGE")
    pundles << bundle("BUNDLE")
  end
end

Parameters:

  • options (Hash) (defaults to: {}) —

    Top-level options for configuring the component.

Yield Parameters:

  • pundles (Array) —

    An array to which nested pundle specifications should be added by the block.

Returns:

  • (Hash) —

    The specification for the component.



37
38
39
 
# File 'lib/jujube/components/scm.rb', line 37

def store(options = {}, &block)
  to_config("store", nested_options(:pundles, options, &block))
end