Improve Jenkinsfile examples

Show more complete examples, including running commands on labelled nodes.
openshift · Jan 3, 2017 · 4949035 · 4949035
1 parent 0b1435e
commit 4949035
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 38 deletions.
diff --git a/app/styles/_forms.less b/app/styles/_forms.less
@@ -27,9 +27,10 @@
   padding: 19px;
   margin-bottom: 20px;
   border: 1px solid @color-pf-black-300;
-  .copy-to-clipboard {
-    margin-top: 3px;
-  }
+}
+
+.jenkinsfile-examples .copy-to-clipboard {
+  margin-top: 3px;
 }
 
 .compute-resource {

diff --git a/app/views/edit/jenkinsfile-examples.html b/app/views/edit/jenkinsfile-examples.html
@@ -1,42 +1,57 @@
-<div>
+<div class="jenkinsfile-examples">
   <p>
     A Jenkinsfile is a Groovy script that defines your pipeline. In the Jenkinsfile, you can declare
     pipeline stages and run one or more steps within each stage. Here are some examples you can use
     in your pipelines.
   </p>
   <p>
-    Declare a new pipeline stage called <var>Build:</var>
+    Checkout source code and run the shell command <var>make:</var>
     <copy-to-clipboard
-        display-wide="true"
-        clipboard-text="'stage \'Build\''">
+      display-wide="true"
+      clipboard-text="'node {
+  stage \'Checkout\'
+  checkout scm
+  stage \'Build\'
+  sh \'make\'
+}
+'" multiline="true">
     </copy-to-clipboard>
   </p>
   <p>
-    Start a build for build config <var>my-build-config:</var>
+    Run an OpenShift build and deployment:
     <copy-to-clipboard
-        display-wide="true"
-        clipboard-text="'openshiftBuild(buildConfig: \'my-build-config\', showBuildLogs: \'true\')'">
+      display-wide="true"
+      clipboard-text="'node {
+  stage \'Build\'
+  openshiftBuild(buildConfig: \'my-build-config\', showBuildLogs: \'true\')
+  stage \'Deploy\'
+  openshiftDeploy(deploymentConfig: \'my-deployment-config\')
+}
+'" multiline="true">
     </copy-to-clipboard>
   </p>
   <p>
-    Start a deployment for deployment config <var>my-deployment-config:</var>
-    <copy-to-clipboard
-        display-wide="true"
-        clipboard-text="'openshiftDeploy(deploymentConfig: \'my-deployment-config\')'">
-    </copy-to-clipboard>
-  </p>
-  <p>
-    Run the shell command <var>make test:</var>
+    Prompt for manual input:
     <copy-to-clipboard
-        display-wide="true"
-        clipboard-text="'sh \'make test\''">
+      display-wide="true"
+      clipboard-text="'node {
+  stage \'Approve\'
+  input \'Promote to production?\'
+}
+'" multiline="true">
     </copy-to-clipboard>
   </p>
   <p>
-    Prompt for manual input:
+    Run stages on a node labelled <var>maven:</var>
     <copy-to-clipboard
-        display-wide="true"
-        clipboard-text="'input \'Promote to production?\''">
+      display-wide="true"
+      clipboard-text="'node(\'maven\') {
+  stage \'Checkout\'
+  checkout scm
+  stage \'Unit Test\'
+  sh \'mvn test\'
+}
+'" multiline="true">
     </copy-to-clipboard>
   </p>
   <p>

diff --git a/dist/scripts/templates.js b/dist/scripts/templates.js
@@ -9251,33 +9251,50 @@ angular.module('openshiftConsoleTemplates', []).run(['$templateCache', function(
 
 
   $templateCache.put('views/edit/jenkinsfile-examples.html',
-    "<div>\n" +
+    "<div class=\"jenkinsfile-examples\">\n" +
     "<p>\n" +
     "A Jenkinsfile is a Groovy script that defines your pipeline. In the Jenkinsfile, you can declare pipeline stages and run one or more steps within each stage. Here are some examples you can use in your pipelines.\n" +
     "</p>\n" +
     "<p>\n" +
-    "Declare a new pipeline stage called <var>Build:</var>\n" +
-    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'stage \\'Build\\''\">\n" +
-    "</copy-to-clipboard>\n" +
-    "</p>\n" +
-    "<p>\n" +
-    "Start a build for build config <var>my-build-config:</var>\n" +
-    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'openshiftBuild(buildConfig: \\'my-build-config\\', showBuildLogs: \\'true\\')'\">\n" +
+    "Checkout source code and run the shell command <var>make:</var>\n" +
+    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'node {\n" +
+    "  stage \\'Checkout\\'\n" +
+    "  checkout scm\n" +
+    "  stage \\'Build\\'\n" +
+    "  sh \\'make\\'\n" +
+    "}\n" +
+    "'\" multiline=\"true\">\n" +
     "</copy-to-clipboard>\n" +
     "</p>\n" +
     "<p>\n" +
-    "Start a deployment for deployment config <var>my-deployment-config:</var>\n" +
-    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'openshiftDeploy(deploymentConfig: \\'my-deployment-config\\')'\">\n" +
+    "Run an OpenShift build and deployment:\n" +
+    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'node {\n" +
+    "  stage \\'Build\\'\n" +
+    "  openshiftBuild(buildConfig: \\'my-build-config\\', showBuildLogs: \\'true\\')\n" +
+    "  stage \\'Deploy\\'\n" +
+    "  openshiftDeploy(deploymentConfig: \\'my-deployment-config\\')\n" +
+    "}\n" +
+    "'\" multiline=\"true\">\n" +
     "</copy-to-clipboard>\n" +
     "</p>\n" +
     "<p>\n" +
-    "Run the shell command <var>make test:</var>\n" +
-    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'sh \\'make test\\''\">\n" +
+    "Prompt for manual input:\n" +
+    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'node {\n" +
+    "  stage \\'Approve\\'\n" +
+    "  input \\'Promote to production?\\'\n" +
+    "}\n" +
+    "'\" multiline=\"true\">\n" +
     "</copy-to-clipboard>\n" +
     "</p>\n" +
     "<p>\n" +
-    "Prompt for manual input:\n" +
-    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'input \\'Promote to production?\\''\">\n" +
+    "Run stages on a node labelled <var>maven:</var>\n" +
+    "<copy-to-clipboard display-wide=\"true\" clipboard-text=\"'node(\\'maven\\') {\n" +
+    "  stage \\'Checkout\\'\n" +
+    "  checkout scm\n" +
+    "  stage \\'Unit Test\\'\n" +
+    "  sh \\'mvn test\\'\n" +
+    "}\n" +
+    "'\" multiline=\"true\">\n" +
     "</copy-to-clipboard>\n" +
     "</p>\n" +
     "<p>\n" +

diff --git a/dist/styles/main.css b/dist/styles/main.css
@@ -3585,7 +3585,7 @@ to{transform:rotate(359deg)}
 .copy-to-clipboard-multiline pre{background-color:#fff;max-width:100%;overflow-x:auto}
 .input-group-addon.wildcard-prefix{padding-left:10px}
 .editor-examples{padding:19px;margin-bottom:20px;border:1px solid #d1d1d1}
-.editor-examples .copy-to-clipboard{margin-top:3px}
+.jenkinsfile-examples .copy-to-clipboard{margin-top:3px}
 .compute-resource{margin-bottom:5px}
 @media (max-width:767px){.compute-resource .inline-select{margin-top:5px}
 }