Pipeline Declarative: Notifications #642

bitwiseman · 2017-02-14T09:16:01Z

@rtyler Draft complete.
@jenkins-infra/copy-editors - It is late, I'm sure there's plenty to be fixed here.

bitwiseman · 2017-02-14T10:42:37Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+}
+----
+
+.Declarative is still Jenkins Pipeline 


@rtyler -
This is meant as an aside,
In the process of writing theses blogs I feel like I've finally figured out a perspective on Declarative the makes sense to me and I wan to communicate that here. Technically, I could just drop this entire section - but I wrote and then deleted a similar section for the previous post, which indicate to me that it is worth bringing up.

I understand we're under time pressure, so if this seems off in the weeds, feel free to nuke it. I needed to finish it, that's all.

daniel-beck

Needs fixing. Only got halfway through, just too much broken to properly review.

daniel-beck · 2017-02-14T11:01:56Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+In this blog post, we'll pull in the notification method we created for
+link:/blog/2016/07/18/pipline-notifications/[Sending Notifications in Pipeline].
+We'll show how the structure of


Incomplete sentence.

daniel-beck · 2017-02-14T11:02:04Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+In this blog post, we'll pull in the notification method we created for
+link:/blog/2016/07/18/pipline-notifications/[Sending Notifications in Pipeline].
+We'll show how the structure of
+Then we'll move that notification sending method into shared library, letting


daniel-beck · 2017-02-14T11:02:21Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+link:/blog/2016/07/18/pipline-notifications/[Sending Notifications in Pipeline].
+We'll show how the structure of
+Then we'll move that notification sending method into shared library, letting
+use call it from other projects and keeping our `Jenkinsfile` concise and


daniel-beck · 2017-02-14T11:03:02Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+- notifications
+- slack
+- hipchat
+- emailext


Missing a hyphen?

Nah, we should avoid adding hyphens to tags

Same as the other blog post. Updating both.

daniel-beck · 2017-02-14T11:03:21Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+== Setup
+
+The setup for this post is a continuation of the previous.


Should link back to that blog post.

daniel-beck · 2017-02-14T11:04:33Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+****
+Jenkins Declarative Pipeline is still *Jenkins*, still *Pipeline*, and still *Groovy*.
+Declarative Pipeline - everything inside
+the `pipeline {}` block - is a domain-specific subset is Groovy, but outside that


is Groovy -> of Groovy

daniel-beck · 2017-02-14T11:04:48Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+****
+Jenkins Declarative Pipeline is still *Jenkins*, still *Pipeline*, and still *Groovy*.
+Declarative Pipeline - everything inside
+the `pipeline {}` block - is a domain-specific subset is Groovy, but outside that


outside -> other than, besides?

Nope. Inside the block ... outside the block. I can change if you feel strongly about it.

Got it. Words, what do they mean?!

daniel-beck · 2017-02-14T11:04:57Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+Jenkins Declarative Pipeline is still *Jenkins*, still *Pipeline*, and still *Groovy*.
+Declarative Pipeline - everything inside
+the `pipeline {}` block - is a domain-specific subset is Groovy, but outside that
+we can still access all the facilities of Java, Groovy, and Scripted Pipeline.


ALL OF GROOVY

not understanding all caps.

Tried a change. Better?

I meant the same as before, Pipeline is a poor imitation of Groovy.

daniel-beck · 2017-02-14T11:05:11Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+we can still access all the facilities of Java, Groovy, and Scripted Pipeline.
+
+Looking at the method definition above, some of you will be saying,
+"Wait minute, wasn't Declarative Pipeline was supposed to get me away from


Wait a minute

daniel-beck · 2017-02-14T11:05:20Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+we can still access all the facilities of Java, Groovy, and Scripted Pipeline.
+
+Looking at the method definition above, some of you will be saying,
+"Wait minute, wasn't Declarative Pipeline was supposed to get me away from


wasn't … was

bitwiseman · 2017-02-14T16:44:51Z

@daniel-beck Thanks for the feedback. I think I addressed everything except this "inside/outside" comment.

rtyler · 2017-02-14T16:23:36Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+- notifications
+- slack
+- hipchat
+- emailext


Nah, we should avoid adding hyphens to tags

rtyler · 2017-02-14T17:28:39Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+In the
+link:/blog/2017/02/10/declarative-html-publisher/[previous blog post],
+we converted Scripted Pipeline to a Declarative Pipeline with descriptive stages
+and `post` blocks.  In one of those `post&#123; }`  blocks, we included a placeholder for


post section, post section. Please be consistent with phrasing used in the syntax reference

rtyler

of course s/pipeline/Pipeline/ where applicable again 😈

rtyler · 2017-02-14T19:25:24Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+== Setup
+
+The setup for this post is a almost the same as the
+link:/blog/2017/02/10/declarative-html-publisher/[previous post].


"the previous post" is a bit vague, how about something like "my previous Declarative Pipeline post"

rtyler · 2017-02-14T19:25:56Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+The setup for this post is a almost the same as the
+link:/blog/2017/02/10/declarative-html-publisher/[previous post].
+I've used a new branch


"I've used a new branch my same fork of the Hermann project:"

-->

"I've used a new branch in my fork of the Hermann project named:"

rtyler · 2017-02-14T19:26:53Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+link:https://github.com/bitwiseman/hermann[my same fork] of the
+link:https://github.com/reiseburo/hermann[hermann project]:
+link:https://github.com/bitwiseman/hermann/tree/blog/declarative/notifications[`blog/add-declarative/notifications`].
+I've set up a Multibranch Pipeline and pointed it at my repository


s/I've set up a/I have also set up a/

rtyler · 2017-02-14T19:28:34Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+link:https://github.com/bitwiseman/hermann/tree/blog/declarative/notifications[`blog/add-declarative/notifications`].
+I've set up a Multibranch Pipeline and pointed it at my repository
+the same as did it previous post.
+Also the same as before, I've set this Pipeline's Git configuration to


To avoid the repetition of "also, also, additionally" I suggest joining this last sentence with the sentence prior, e.g.

I have also set up a Multibranch Pipeline pointed at my repository, using the Pipeline's Git configuration to automatically "Clean after checkout", just as in my previous post.

rtyler · 2017-02-14T19:29:40Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+Also the same as before, I've set this Pipeline's Git configuration to
+automatically "Clean after checkout".
+
+In addition, I still have my notification targets setup from the


I'm not sure I follow what "notification targets" are in context here. Perhaps rephrase or elaborate on what this means.

The channel on which I receive the notifications.

rtyler · 2017-02-14T19:52:06Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+}
+----
+
+.vars/sendNotifications.txt


I suggest removing this file from the blog post, since it's not explained

rtyler · 2017-02-14T19:53:10Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+ * Send notifications based on build status string
+ */
+def call(String buildStatus = 'STARTED') {
+  // build status of null means successful


This is the third time in this blog post that the full method body has been pasted. I suggest just linking to the full file on GitHub so we can get to the Jenkinsfile faster here.

If you're married to including all this text (again!) then move the Jenkinsfile to the top.

rtyler · 2017-02-14T19:54:06Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+----
+
+
+== Conclusion


Before the inclusion, please include at least once screenshot of this "all working" with a notification showing up in HipChat or something like that. I need closure!

I'll to this in a minute.

rtyler · 2017-02-14T19:54:44Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+end of the file with no reformatting elsewhere.
+Then with the help of the Shared Library feature,
+we've moved the implementation of `sendNotifications` out of
+`Jenkinsfile`.  This will let easily reuse that code in other


s/This will let easily/This will let us easily/

rtyler · 2017-02-14T19:55:07Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+we've moved the implementation of `sendNotifications` out of
+`Jenkinsfile`.  This will let easily reuse that code in other
+projects and maintains the clarity of our Pipeline.
+In the next post, we'll look at running Sauce OnDemand with


This last sentence seems kind of crammed in here. I suggest rewording to flow better. (no suggestions off the top of my head)

bitwiseman · 2017-02-14T21:51:54Z

@rtyler
re P-vs-p-ipeline: Dude, half the time it is debatable which meaning (and thus which capitalization applies. My first post I capitalized most them because I meant Pipeline, but the feed back was somewhat at random to lowercase. 😄 I'll review them again.

daniel-beck · 2017-02-14T22:49:43Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+NOTE: This is a guest post by link:https://github.com/bitwiseman[Liam Newman],
+Technical Evangelist at link:https://cloudbees.com[CloudBees].
+
+**Declare Your Pipelines!**


Gentlemen, declare your pipelines! 😆

To clarify, not a review finding.

daniel-beck · 2017-02-14T22:50:32Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+integrating notification services Slack, HipChat, and Email, into our Declarative Pipeline.
+Then we'll move that method into a shared library,
+keeping our `Jenkinsfile` concise and understandable,
+and letting use call that method from other projects.


daniel-beck · 2017-02-14T22:51:05Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+The setup for this post is a almost the same as the
+link:/blog/2017/02/10/declarative-html-publisher/[my previous Declarative Pipeline post].
+I've used a new branch in


daniel-beck · 2017-02-14T22:51:23Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+We'll start from the same Pipeline we had at the end of the previous post.
+
+It works quiet well, but only only has  that final `always` directive that prints a message to the console log,


daniel-beck · 2017-02-14T22:51:29Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+We'll start from the same Pipeline we had at the end of the previous post.
+
+It works quiet well, but only only has  that final `always` directive that prints a message to the console log,


daniel-beck · 2017-02-14T22:58:16Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+There are a few limitations for methods in Shared Libraries, but they don't apply here.
+The minimal set of dependencies for `sendNotifications` means we can once again
+basically copy-and-paste the code across.


across who or what?

Huh, I wouldn't have thought that this phrasing is particularly idiomatic, but it's correct English. "Copy and paste the code across from the original Jenkinsfile" is the implied meaning.

daniel-beck · 2017-02-14T22:58:32Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+The minimal set of dependencies for `sendNotifications` means we can once again
+basically copy-and-paste the code across.
+We'll check this change into a branch in the library, named
+`blog/declarative/notifications` the same as my branch in the `hermann` repository.


Is there a comma missing somewhere?

daniel-beck · 2017-02-14T22:58:43Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+We'll check this change into a branch in the library, named
+`blog/declarative/notifications` the same as my branch in the `hermann` repository.
+This will let us make changes on the master branch later without breaking this example.
+We'll use use the `@Library` directive to tell Jenkins to use that branch's version


daniel-beck · 2017-02-14T22:58:58Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+`blog/declarative/notifications` the same as my branch in the `hermann` repository.
+This will let us make changes on the master branch later without breaking this example.
+We'll use use the `@Library` directive to tell Jenkins to use that branch's version
+of the library with this Pipeline.


Unclear sentence.

daniel-beck · 2017-02-14T23:00:53Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+}
+// Scripted //
+----
+<1> The `_` here is intentional.


Does the underscore appear correctly in output? GitHub doesn't like it.

orrc · 2017-02-14T23:36:19Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+I've used a new branch in
+link:https://github.com/bitwiseman/hermann[my fork] of the
+link:https://github.com/reiseburo/hermann[Hermann project]:
+link:https://github.com/bitwiseman/hermann/tree/blog/declarative/notifications[`blog/add-declarative/notifications`].


Minor: the anchor text should match the URL, i.e. add-declarative -> declarative

orrc · 2017-02-14T23:36:21Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+I still have my private notification targets (where we'll send notifications) which I created for the
+"link:/blog/2016/07/18/pipline-notifications/[Sending Notifications in Pipeline]" blog post.
+Take a look at that post to review how to I setup the


"how to I setup" -> "how I set up"

orrc · 2017-02-14T23:37:47Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+I'd already set up a Multibranch Pipeline and pointed it at my repository,
+so the new branch will be picked up and built automatically.
+
+I still have my private notification targets (where we'll send notifications) which I created for the


Not sure the word "private" is necessary here.

orrc · 2017-02-14T23:41:37Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+The shared library functionality has too many configuration options to cover in one post.
+I've chosen to configure this library as a "Global Pipeline Library",
+accessible from any project on my Jenkins master.
+To setup a "Global Pipeline Library", navigated to "Manage Jenkins" -> "Configure System"


"setup" -> "set up"

orrc · 2017-02-14T23:47:28Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+There are a few limitations for methods in Shared Libraries, but they don't apply here.
+The minimal set of dependencies for `sendNotifications` means we can once again
+basically copy-and-paste the code across.


Huh, I wouldn't have thought that this phrasing is particularly idiomatic, but it's correct English. "Copy and paste the code across from the original Jenkinsfile" is the implied meaning.

orrc · 2017-02-14T23:50:18Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+----
+<1> The `_` here is intentional.
+link:https://en.wikipedia.org/wiki/Java_annotation[Java/Groovy Annotations]
+such `@Library` must be applied to an element.


"such" -> "such as"

orrc · 2017-02-14T23:52:58Z

content/blog/2017/2017-02-14-declarative-notifications.adoc

+
+=== Moving the Code to the Library
+
+Moving a method or class to a library involves creating a file with the name of our method,


A wee bit more detail on the shared lib structure and naming would be nice, e.g.:

creating a file in the vars directory with the name of our method — in this case vars/sendNotifications.groovy

bitwiseman · 2017-02-15T18:01:41Z

90 comments and counting. 😞 I will do better.

bitwiseman added 3 commits February 13, 2017 16:44

Added declarative notifications

9c74d83

Finished draft and added images

e2a1bd3

Updated aside about Declarative syntax

09109dd

bitwiseman commented Feb 14, 2017

View reviewed changes

daniel-beck requested changes Feb 14, 2017

View reviewed changes

bitwiseman force-pushed the feature/declarative/notifications branch from 3b97689 to 2547055 Compare February 14, 2017 16:31

rtyler requested changes Feb 14, 2017

View reviewed changes

bitwiseman force-pushed the feature/declarative/notifications branch from 2547055 to f33fcb3 Compare February 14, 2017 19:52

rtyler requested changes Feb 14, 2017

View reviewed changes

Made changes based on feedback

669b41b

bitwiseman force-pushed the feature/declarative/notifications branch from 2ab21ca to 669b41b Compare February 14, 2017 21:21

daniel-beck requested changes Feb 14, 2017

View reviewed changes

orrc reviewed Feb 14, 2017

View reviewed changes

bitwiseman force-pushed the feature/declarative/notifications branch from 8fcf844 to 126bcdf Compare February 15, 2017 07:05

Reorganized to avoid non-declarative hacks

d4d7cfb

bitwiseman force-pushed the feature/declarative/notifications branch from 126bcdf to d4d7cfb Compare February 15, 2017 08:05

Removed dead words

7239fd3

bitwiseman force-pushed the feature/declarative/notifications branch from a2913af to 7239fd3 Compare February 15, 2017 17:47

More dead word removal

5708400

bitwiseman force-pushed the feature/declarative/notifications branch from fbdae29 to 5708400 Compare February 15, 2017 17:56

Fixed typo

1ad3138

rtyler closed this in 413e7f8 Feb 15, 2017

MarcelRaschke mentioned this pull request Aug 20, 2022

[Snyk] Security upgrade http-server from 0.12.3 to 0.13.0 meonBot/jenkins.io#4

Open


		== Setup

		The setup for this post is a continuation of the previous.


		We'll start from the same Pipeline we had at the end of the previous post.

		It works quiet well, but only only has that final `always` directive that prints a message to the console log,


		=== Moving the Code to the Library

		Moving a method or class to a library involves creating a file with the name of our method,

		----


		== Conclusion

Pipeline Declarative: Notifications #642

Pipeline Declarative: Notifications #642

Conversation

bitwiseman commented Feb 14, 2017 • edited Loading

Choose a reason for hiding this comment

daniel-beck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitwiseman Feb 14, 2017 • edited Loading

Choose a reason for hiding this comment

daniel-beck Feb 14, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitwiseman commented Feb 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rtyler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitwiseman commented Feb 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitwiseman commented Feb 15, 2017

bitwiseman commented Feb 14, 2017 •

edited

Loading

bitwiseman Feb 14, 2017 •

edited

Loading

daniel-beck Feb 14, 2017 •

edited

Loading