rubyjobbuilderdsl 0.0.4 → 0.0.5

data/docs/freestyle.md

@@ -1,100 +1,100 @@
-## Create free style project
-
-**ant**
-
-Description: Run ant task
-
-Multiple: Add
-
-Example
-
-    builder.freestyle 'hello_world-build' do
-      ant do
-        target 'clean', 'lint'
-        buildfile 'nightly.xml'
-        java_opts '-Xmx512m', '-Xms512m'
-        property 'skipTest' => 'false'
-      end
-    end
-
-**batch**
-
-Description: Run batch command
-
-Multiple: Add
-
-Example
-
-    builder.freestyle 'hello_world-master' do
-      batch 'sc.exe query'
-    end
-
-**copyartifact**
-
-Description: Copy artifact from other build
-
-Multiple: Add
-
-Example
-
-    builder.freestyle 'hello_world-servicetest' do
-      copyartifact '$ARTIFACT_JOB' do
-        build_number '$ARTIFACT_BUILD_NUMBER'
-        file 'package/**',
-             'output/**'
-        to '$BUILD_NUMBER'
-      end
-    end
-
-**inject_env**
-
-Description: Create environment variable that persists in the build
-
-Multiple: Add
-
-Example
-
-    builder.freestyle 'hello_world-build' do
-      inject_env do
-        properties_content 'EXAMPLE=foo'
-        properties_file 'env.prop'
-      end
-    end
-
-**powershell**
-
-Description: Run Powershell command
-
-Multiple: Add
-
-Example
-
-    builder.freestyle 'hello_world-master' do
-      powershell 'Get-Service MSQL* | foreach { sc.exe stop $_.Name }'
-    end
-
-**shell**
-
-Description: Run shell command
-
-Multiple: Add
-
-Example
-
-    builder.freestyle 'ops-master' do
-      shell 'rm -rf * || true'
-    end
-
-**workspace**
-
-Description: Set custom workspace for job
-
-Multiple:  Override
-
-Example
-
-    builder.freestyle 'ops-master' do
-      workspace 'ops-m'
-    end
-
-
+## Create free style project
+
+**ant**
+
+Description: Run ant task
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      ant do
+        target 'clean', 'lint'
+        buildfile 'nightly.xml'
+        java_opts '-Xmx512m', '-Xms512m'
+        property 'skipTest' => 'false'
+      end
+    end
+
+**batch**
+
+Description: Run batch command
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      batch 'sc.exe query'
+    end
+
+**copyartifact**
+
+Description: Copy artifact from other build
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-servicetest' do
+      copyartifact '$ARTIFACT_JOB' do
+        build_number '$ARTIFACT_BUILD_NUMBER'
+        file 'package/**',
+             'output/**'
+        to '$BUILD_NUMBER'
+      end
+    end
+
+**inject_env**
+
+Description: Create environment variable that persists in the build
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-build' do
+      inject_env do
+        properties_content 'EXAMPLE=foo'
+        properties_file 'env.prop'
+      end
+    end
+
+**powershell**
+
+Description: Run Powershell command
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      powershell 'Get-Service MSQL* | foreach { sc.exe stop $_.Name }'
+    end
+
+**shell**
+
+Description: Run shell command
+
+Multiple: Add
+
+Example
+
+    builder.freestyle 'ops-master' do
+      shell 'rm -rf * || true'
+    end
+
+**workspace**
+
+Description: Set custom workspace for job
+
+Multiple:  Override
+
+Example
+
+    builder.freestyle 'ops-master' do
+      workspace 'ops-m'
+    end
+
+

data/docs/gerrit.md

@@ -1,70 +1,70 @@
-## Configure job to act on gerrit event
-
-**change_merged**
-
-Description: trigger the job on Gerrit change_merged event
-
-Multiple: Override
-
-Example
-
-    builder.flow 'hello_world-post' do
-      gerrit do
-        change_merged
-        project 'hello_world' do
-          branch 'master','release'
-        end
-      end
-    end
-
-**comment_added**
-
-Description: trigger the job on Gerrit comment_added event
-
-Multiple: Override
-
-Example
-
-    builder.flow 'hello_world-gate' do
-      gerrit do
-        comment_added 'Code-Review' => '2'
-        project 'hello_world' do
-          branch 'master','release'
-        end
-      end
-    end
-
-**patchset_uploaded**
-
-Description: trigger the job on Gerrit patchset_uploaded event
-
-Multiple: Override
-
-Example
-
-    builder.flow 'hello_world-build' do
-      gerrit do
-        patchset_uploaded
-        project 'hello_world' do
-          branch 'master','release'
-        end
-      end
-    end
-
-**project**
-
-Description: Specify a Gerrit event filter that trigger the job
-
-Multiple: Override
-
-Example
-
-    builder.flow 'salesforce-post' do
-      gerrit do
-        project 'poland/technicalcomponents' do
-          branch 'master','release'
-          file 'src/Salesforce/**',
-               'src/Db/Salesforce/**'
-        end
-      end
-    end
+## Configure job to act on gerrit event
+
+**change_merged**
+
+Description: trigger the job on Gerrit change_merged event
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-post' do
+      gerrit do
+        change_merged
+        project 'hello_world' do
+          branch 'master','release'
+        end
+      end
+    end
+
+**comment_added**
+
+Description: trigger the job on Gerrit comment_added event
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-gate' do
+      gerrit do
+        comment_added 'Code-Review' => '2'
+        project 'hello_world' do
+          branch 'master','release'
+        end
+      end
+    end
+
+**patchset_uploaded**
+
+Description: trigger the job on Gerrit patchset_uploaded event
+
+Multiple: Override
+
+Example
+
+    builder.flow 'hello_world-build' do
+      gerrit do
+        patchset_uploaded
+        project 'hello_world' do
+          branch 'master','release'
+        end
+      end
+    end
+
+**project**
+
+Description: Specify a Gerrit event filter that trigger the job
+
+Multiple: Override
+
+Example
+
+    builder.flow 'salesforce-post' do
+      gerrit do
+        project 'poland/technicalcomponents' do
+          branch 'master','release'
+          file 'src/Salesforce/**',
+               'src/Db/Salesforce/**'
+        end
+      end
+    end

data/docs/git.md

@@ -1,88 +1,88 @@
-## Configure Git SCM
-
-**git**
-
-Description: Configure Git version as SCM
-
-Multiple: Override
-
-Example
-
-    builder.freestyle 'hello_world-master' do
-      git do
-        url 'ssh://builduser@gerrit.acme.com:29418/hello_world'
-        basedir 'hello_world'
-        reference_repo '$HOME/hello_world.git'
-        branches '$GERRIT_BRANCH'
-        refspec '$GERRIT_REFSPEC'
-        choosing_strategy 'gerrit'
-        git_config_name 'foo'
-        git_config_email 'foo@acme.com'
-      end
-    end
-
-**jgit**
-
-Description: Configure Git version as SCM using jgit. Credentials must be created with the specified id using groovy script
-
-Multiple: Override
-
-Example
-
-    builder.freestyle 'hello_world-master' do
-      git do
-        url 'ssh://builduser@gerrit.acme.com:29418/hello_world'
-        basedir 'hello_world'
-        reference_repo '$HOME/hello_world.git'
-        branches '$GERRIT_BRANCH'
-        refspec '$GERRIT_REFSPEC'
-        choosing_strategy 'gerrit'
-        git_config_name 'foo'
-        git_config_email 'foo@acme.com'
-        jgit
-        credentials 'foo'
-      end
-    end
-
-Example of creating credentials
-
-    import jenkins.model.*
-    import hudson.plugins.sshslaves.*
-    import com.cloudbees.plugins.credentials.*
-    import com.cloudbees.plugins.credentials.common.*
-    import com.cloudbees.plugins.credentials.domains.*
-    import com.cloudbees.jenkins.plugins.sshcredentials.impl.*
-
-    domain = Domain.global()
-    store = Jenkins.instance.getExtensionList(
-      'com.cloudbees.plugins.credentials.SystemCredentialsProvider'
-    )[0].getStore()
-
-    username = credentialsId = 'foo'
-    passphrase = description = null
-
-    privateKey = """
-    -----BEGIN RSA PRIVATE KEY-----
-    MIIEoQIBAAKCAQEAyTsKNPUc4GkfZjNlLmLpuS+wecpCQOJs7MubPoNGk5F0cK4Q
-    ...
-    -----END RSA PRIVATE KEY-----
-    """
-
-    credentials = new BasicSSHUserPrivateKey(
-      CredentialsScope.GLOBAL,
-      credentialsId,
-      username,
-      new BasicSSHUserPrivateKey.DirectEntryPrivateKeySource(privateKey),
-      passphrase,
-      description
-    )
-
-    existing = store.getCredentials(domain).find { it.id == credentialsId }
-    if (existing) {
-      println "removing ${credentialsId}"
-      store.removeCredentials(domain, existing)
-    }
-
-    println "adding ${credentialsId}"
-    store.addCredentials(domain, credentials)
-
+## Configure Git SCM
+
+**git**
+
+Description: Configure Git version as SCM
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      git do
+        url 'ssh://builduser@gerrit.acme.com:29418/hello_world'
+        basedir 'hello_world'
+        reference_repo '$HOME/hello_world.git'
+        branches '$GERRIT_BRANCH'
+        refspec '$GERRIT_REFSPEC'
+        choosing_strategy 'gerrit'
+        git_config_name 'foo'
+        git_config_email 'foo@acme.com'
+      end
+    end
+
+**jgit**
+
+Description: Configure Git version as SCM using jgit. Credentials must be created with the specified id using groovy script
+
+Multiple: Override
+
+Example
+
+    builder.freestyle 'hello_world-master' do
+      git do
+        url 'ssh://builduser@gerrit.acme.com:29418/hello_world'
+        basedir 'hello_world'
+        reference_repo '$HOME/hello_world.git'
+        branches '$GERRIT_BRANCH'
+        refspec '$GERRIT_REFSPEC'
+        choosing_strategy 'gerrit'
+        git_config_name 'foo'
+        git_config_email 'foo@acme.com'
+        jgit
+        credentials 'foo'
+      end
+    end
+
+Example of creating credentials
+
+    import jenkins.model.*
+    import hudson.plugins.sshslaves.*
+    import com.cloudbees.plugins.credentials.*
+    import com.cloudbees.plugins.credentials.common.*
+    import com.cloudbees.plugins.credentials.domains.*
+    import com.cloudbees.jenkins.plugins.sshcredentials.impl.*
+
+    domain = Domain.global()
+    store = Jenkins.instance.getExtensionList(
+      'com.cloudbees.plugins.credentials.SystemCredentialsProvider'
+    )[0].getStore()
+
+    username = credentialsId = 'foo'
+    passphrase = description = null
+
+    privateKey = """
+    -----BEGIN RSA PRIVATE KEY-----
+    MIIEoQIBAAKCAQEAyTsKNPUc4GkfZjNlLmLpuS+wecpCQOJs7MubPoNGk5F0cK4Q
+    ...
+    -----END RSA PRIVATE KEY-----
+    """
+
+    credentials = new BasicSSHUserPrivateKey(
+      CredentialsScope.GLOBAL,
+      credentialsId,
+      username,
+      new BasicSSHUserPrivateKey.DirectEntryPrivateKeySource(privateKey),
+      passphrase,
+      description
+    )
+
+    existing = store.getCredentials(domain).find { it.id == credentialsId }
+    if (existing) {
+      println "removing ${credentialsId}"
+      store.removeCredentials(domain, existing)
+    }
+
+    println "adding ${credentialsId}"
+    store.addCredentials(domain, credentials)
+

data/docs/multi.md

@@ -1,27 +1,27 @@
-## Create multi job project
-
-**phase**
-
-Description: Run a job phase. Phases are executed sequentially, however jobs within a phase run in parallel.
-
-Multiple: Add
-
-Example
-
-    builder.multi 'hello_world-deploy' do
-      phase 'hello_world-db-deploy' do
-        job 'foo-db'
-
-        job 'bar-db' do
-          ignore_result true
-        end
-      end
-
-      phase 'hello_world-service-deploy' do
-        job 'foo-service' do
-          retries 1
-          abort_others false
-        end
-        job 'bar-service'
-      end
+## Create multi job project
+
+**phase**
+
+Description: Run a job phase. Phases are executed sequentially, however jobs within a phase run in parallel.
+
+Multiple: Add
+
+Example
+
+    builder.multi 'hello_world-deploy' do
+      phase 'hello_world-db-deploy' do
+        job 'foo-db'
+
+        job 'bar-db' do
+          ignore_result true
+        end
+      end
+
+      phase 'hello_world-service-deploy' do
+        job 'foo-service' do
+          retries 1
+          abort_others false
+        end
+        job 'bar-service'
+      end
     end