Skip to content

Commit

Permalink
Add notes for where declarative pipeline examples are not yet impleme…
Browse files Browse the repository at this point in the history
…nted

Once Declarative is an integral part of Pipeline, these should be updated
  • Loading branch information
R. Tyler Croy committed Dec 2, 2016
1 parent 572ef6a commit 757125b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
1 change: 1 addition & 0 deletions content/doc/book/pipeline/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ web UI, using two valuable steps.
node { // <1>
echo 'Hello World' // <2>
}
// Declarative not yet implemented //
----
<1> `node` allocates an executor and workspace in the Jenkins environment.
<2> `echo` writes simple string in the Console Output.
Expand Down
2 changes: 2 additions & 0 deletions content/doc/book/pipeline/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ node { // <1>
sh 'make publish'
}
}
// Declarative not yet implemented //
----
<1> <<node,`node`>> indicates that Jenkins should allocate an executor and workspace for
this part of the Pipeline.
Expand Down
11 changes: 11 additions & 0 deletions content/doc/book/pipeline/jenkinsfile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ node { // <1>
/* .. snip .. */
}
}
// Declarative not yet implemented //
----
<1> `node` allocates an executor and workspace in the Jenkins environment.
<2> `stage` describes distinct parts of the Pipeline for better visualization of progress/status.
Expand Down Expand Up @@ -88,6 +89,7 @@ node {
checkout scm // <1>
/* .. snip .. */
}
// Declarative not yet implemented //
----
<1> The `checkout` step will checkout code from source control; `scm` is a
special variable which instructs the `checkout` step to clone the specific
Expand Down Expand Up @@ -118,6 +120,7 @@ node {
}
/* .. snip .. */
}
// Declarative not yet implemented //
----
<1> The `sh` step invokes the `make` command and will only continue if a
zero exit code is returned by the command. Any non-zero exit code will fail the
Expand Down Expand Up @@ -162,6 +165,7 @@ node {
}
/* .. snip .. */
}
// Declarative not yet implemented //
----
<1> Using an inline shell conditional (`sh 'make || true'`) ensures that the
`sh` step always sees a zero exit code, giving the `junit` step the opportunity
Expand Down Expand Up @@ -193,6 +197,7 @@ node {
}
/* .. snip .. */
}
// Declarative not yet implemented //
----
<1> Accessing the `currentBuild.result` variable allows the Pipeline Script to
determine if there were any test failures. In which case, the value would be
Expand Down Expand Up @@ -272,6 +277,7 @@ for example:
node {
echo "Running ${env.BUILD_ID} on ${env.JENKINS_URL}"
}
// Declarative not yet implemented //
----


Expand All @@ -290,6 +296,7 @@ node {
sh 'mvn -B verify'
}
}
// Declarative not yet implemented //
----


Expand All @@ -310,6 +317,7 @@ Pipeline project in the web UI, a `Jenkinsfile` can access that parameter via
node {
echo "${Greeting} World!"
}
// Declarative not yet implemented //
----

/////
Expand Down Expand Up @@ -345,6 +353,7 @@ node {
}
/* .. snip .. */
}
// Declarative not yet implemented //
----

=== Using multiple nodes
Expand Down Expand Up @@ -392,6 +401,7 @@ stage('Test') {
}
}
}
// Declarative not yet implemented //
----
<1> The `stash` step allows capturing files matching an inclusion pattern
(`**/target/*.jar`) for reuse within the _same_ Pipeline. Once the Pipeline has
Expand Down Expand Up @@ -441,6 +451,7 @@ stage('Test') {
}
}
}
// Declarative not yet implemented //
----

Instead of executing the tests on the "linux" and "windows" labelled nodes in
Expand Down

0 comments on commit 757125b

Please sign in to comment.