Clarify npm declarative container example (jfrog#198)

audiwipro · May 16, 2020 · 4132f2e · 4132f2e
1 parent 3b3c041
commit 4132f2e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/jenkins-examples/pipeline-examples/declarative-examples/README.md b/jenkins-examples/pipeline-examples/declarative-examples/README.md
@@ -15,7 +15,7 @@ To set up Jenkins to use the example, read [this](https://github.com/jfrog/proje
 * The [interactive-promotion-example](interactive-promotion-example) demonstrates how to promote a build in Artifactory after the build finished.
 * The [issues-collection-example](issues-collection-example) demonstrates how to collect the list of tracked project issues and add them to the build-info.
 * The [maven-example](maven-example) resolves dependencies, deploys artifacts and publishes build-info to Artifactory for a Maven build.
-* The [npm-container-example](npm-container-example) demonstrates how to run npm in a Docker container.
+* The [npm-container-example](npm-container-example) demonstrates how to run npm in a Docker container. Use this example only in **Multibranch Pipeline** or a **Pipeline from SCM**, as instructed [here](https://jenkins.io/doc/book/pipeline/syntax/#agent) under **dockerfile**. 
 * The [npm-example](npm-example) resolves dependencies, deploys artifacts and publishes build-info to Artifactory for a npm build.
 * The [promotion-example](promotion-example) demonstrates how to promote a build in Artifactory.
 * The [props-example](props-example) demonstrates setting/deleting properties on artifacts in Artifactory. Also downloads and uploads files to Artifactory with properties, while using a placeholder when downloading.

diff --git a/jenkins-examples/pipeline-examples/declarative-examples/npm-container-example/Jenkinsfile b/jenkins-examples/pipeline-examples/declarative-examples/npm-container-example/Jenkinsfile
@@ -1,4 +1,9 @@
 pipeline {
+    /**
+     *  In this example, the agent's Dockerfile is within the repository.
+     *  Therefore, you must use this example only in "Multibranch Pipeline" or a "Pipeline from SCM".
+     *  More information here: https://jenkins.io/doc/book/pipeline/syntax/#agent under "dockerfile".
+     */
     agent {
         dockerfile {
             dir 'jenkins-examples/pipeline-examples/resources/npm'
@@ -10,12 +15,6 @@ pipeline {
     }
 
     stages {
-        stage('Clone') {
-            steps {
-                git branch: 'master', url: "https://github.com/jfrog/project-examples.git"
-            }
-        }
-
         stage('Artifactory configuration') {
             steps {
                 rtServer(