Adding declarative blog for GA release #581

HRMPW · 2017-02-02T19:59:47Z

added new blog for Declarative release.

I also updated the link from the Jenkins.io home page to point to the new documentation pages for now instead of the solutions page because the information there is much better.

@rtyler @michaelneale @bitwiseman @abayer

michaelneale · 2017-02-02T22:20:03Z

@HRMPW could this have screen caps for the editor?

HRMPW · 2017-02-02T22:21:55Z

@michaelneale do we want those in this blog or do we want a separate blog dedicated to the editor explaining how it ties into Declarative?

bitwiseman · 2017-02-02T22:57:12Z

The editor is part of Blue Ocean, isn't it?

HRMPW · 2017-02-02T23:12:59Z

@bitwiseman Yes, there is a preview release of the editor coming that we can demonstrate but it will be released with BO. That is why I want it in a separate blog

bitwiseman

Looking good. A few tweaks and suggestions.

bitwiseman · 2017-02-02T22:59:56Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+flow of the pipeline and provides a common foundation across all pipelines.
+
+= Pipeline as Code
+Pipeline as Code was one of the pillars of the Jenkins 2.0 release and an essential part of implementing continuous delivery. Defining all of the stages of an application's CD pipeline within a "Jenkinsfile" and treating it as part of the application code automatically provides all of the benefits inherent in SCM:


Cloud you breakup this long line?

" and treating it as part"
I would say it's not "treating". Maybe "and having it checked-in as part"

bitwiseman · 2017-02-02T23:03:48Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+this new syntax is much more approachable with an easy adoption curve to quickly
+realize all of the benefits of Pipeline as Code. In addition, the predefined structure
+of Declarative makes it possible to create and edit pipelines with a graphical
+user interface (GUI). The Blue Ocean team is actively working on a Pipeline Editor


Link to an earlier blog on the editor?

bitwiseman · 2017-02-02T23:04:25Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+link:https://www.cloudbees.com/introducing-new-way-define-jenkins-pipelines[Jenkins World]
+in September, it has already been installed over 5,000 times.
+
+If you haven't tried Pipeline or have considered Pipeline in the past we believe


past we -> past, we

bitwiseman · 2017-02-02T23:04:44Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+user interface (GUI). The Blue Ocean team is actively working on a Pipeline Editor
+that will be included in an upcoming release.
+
+If you have already begun using Pipelines in Jenkins we believe that this new alternative


Jenkins, we

Though who is the "we"? :)

bitwiseman · 2017-02-02T23:06:42Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+a pipeline, having a straightforward structure helps to understand and predict the
+flow of the pipeline and provides a common foundation across all pipelines.
+
+= Pipeline as Code


I think we start at == because the title is provide by header.
== Pipeline as Code

bitwiseman · 2017-02-02T23:06:50Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+* Audit changes to the pipeline
+* Run the same pipeline on a different Jenkins server
+
+= Getting Started with Declarative Pipeline


bitwiseman · 2017-02-02T23:07:01Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+visualization. All existing pipeline steps, global variables and shared libraries can be used
+in either. You can now create more cookie-cutter pipelines and extend the power of Pipeline to all users regardless of Groovy expertise.
+
+= Declarative Pipeline Features


bitwiseman · 2017-02-02T23:13:46Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+that will be included in an upcoming release.
+
+If you have already begun using Pipelines in Jenkins we believe that this new alternative
+syntax can help expand that usage. The original syntax for defining pipelines in Jenkins


I think everything after "The original syntax for" doesn't do much to support the first sentence.
It seems like a new paragraph.

Off hand something like:

If you have already begun using Pipelines in Jenkins we believe that this new alternative syntax can help expand that usage. You can now create more cookie-cutter pipelines and extend the power of Pipeline to all users regardless of Groovy expertise. // Another supporting sentence here The original syntax for defining pipelines in Jenkins is still fully supported and is now referred to as "Scripted Pipeline Syntax" to distinguish it from "Declarative Pipeline Syntax." Both use the same underlying execution engine in Jenkins and both will generate the same results in Pipeline Stage View or Blue Ocean visualization. All existing pipeline steps, global variables and shared libraries can be used in either.

bitwiseman · 2017-02-02T23:18:49Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+** Skip stages based on branches, environment, or other Boolean expression
+
+= Where Can I Learn More?
+Be on the lookout for future blog posts here or on Jekins.io detailing specific examples


"here or on Jekins.io"? You mean, "here on Jenkins.io"?

yes, good catch

michaelneale · 2017-02-02T23:23:33Z

(thinking on this...)

michaelneale · 2017-02-02T23:52:01Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+* Review new changes to the pipeline in code review
+* Test new pipeline steps in branches
+* Audit changes to the pipeline
+* Run the same pipeline on a different Jenkins server


Suggestion:

'View diffs clearly between pipeline versions, merge changes'

"pipeline" -> "Pipeline" in all cases in this block, as per the styleguide.

michaelneale · 2017-02-03T00:00:00Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+** Quickly define options (such as timeout, retry, build discarding) for your pipeline
+* Conditional actions
+** Send notifications or take actions depending upon success or failure
+** Skip stages based on branches, environment, or other Boolean expression


** Round trip editing with the visual pipeline editor (watch for preview release shortly)

** Simple syntax that works well with git for diffs and merges

More "pipeline" -> "Pipeline"

michaelneale · 2017-02-03T00:00:53Z

Put some suggestions in but LGTM

orrc · 2017-02-03T01:42:56Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+link:https://plugins.jenkins.io/pipeline-model-definition[Declarative Pipeline syntax]
+1.0 to
+link:https://plugins.jenkins.io/workflow-aggregator[Jenkins Pipeline.]
+We think this new syntax will enable everyone involved in DevOps, regardless of expertise,


It seems there are no examples of declarative syntax in a blog post about declarative syntax ;)

So I'd link "new syntax" to the new syntax documentation: https://jenkins.io/doc/book/pipeline/

orrc · 2017-02-03T01:44:55Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

@@ -0,0 +1,89 @@
+---
+layout: post
+title: "Declarative Pipeline Syntax 1.0 is GA"


I'm not sure the term "is GA" is hugely well known, and seems a bit out of place in the title — maybe more simply, "is here", or "released"…

orrc · 2017-02-03T01:45:22Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+* Rollback to a previous pipeline version
+* Review new changes to the pipeline in code review
+* Test new pipeline steps in branches
+* Audit changes to the pipeline


I think this point is redundant; it's already covered by "review new changes" (along with "retain history").

orrc · 2017-02-03T01:45:33Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+* Review new changes to the pipeline in code review
+* Test new pipeline steps in branches
+* Audit changes to the pipeline
+* Run the same pipeline on a different Jenkins server


"pipeline" -> "Pipeline" in all cases in this block, as per the styleguide.

orrc · 2017-02-03T01:46:19Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+We recommend people begin using it for all their Pipeline definitions in Jenkins.
+The plugin has been available for use and testing starting with the 0.1 release that was debuted at
+link:https://www.cloudbees.com/introducing-new-way-define-jenkins-pipelines[Jenkins World]
+in September, it has already been installed over 5,000 times.


I'd end the sentence where the comma is. Then: "Since then, it has already been…"

orrc · 2017-02-03T01:46:51Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+
+If you haven't tried Pipeline or have considered Pipeline in the past we believe
+this new syntax is much more approachable with an easy adoption curve to quickly
+realize all of the benefits of Pipeline as Code. In addition, the predefined structure


I think house style calls for "predefined" -> "pre-defined"

orrc · 2017-02-03T01:47:30Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+user interface (GUI). The Blue Ocean team is actively working on a Pipeline Editor
+that will be included in an upcoming release.
+
+If you have already begun using Pipelines in Jenkins we believe that this new alternative


Though who is the "we"? :)

orrc · 2017-02-03T01:48:04Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+is a Groovy DSL that allows most of the features of full imperative programming.
+This syntax is still fully supported and is now referred to as "Scripted Pipeline Syntax"
+to distinguish it from "Declarative Pipeline Syntax." Both use the same underlying execution
+engine in Jenkins and both will generate the same results in Pipeline Stage View or Blue Ocean


"Pipeline Stage View" could be a plugins.j.io link

orrc · 2017-02-03T01:48:50Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+** Quickly define options (such as timeout, retry, build discarding) for your pipeline
+* Conditional actions
+** Send notifications or take actions depending upon success or failure
+** Skip stages based on branches, environment, or other Boolean expression


More "pipeline" -> "Pipeline"

orrc · 2017-02-03T01:53:27Z

content/blog/2017/2017-02-06-declarative-pipeline-ga.adoc

+* link:https://en.wikipedia.org/wiki/Lint_%28software%29[Syntax Checking]
+** Immediate runtime syntax checking with explicit error messages
+** API endpoint for linting Jenkinsfiles
+** CLI command to lint Jenkinsfiles


I didn't know about these features, but I did manage to find some documentation on the plugin's GitHub wiki.

Perhaps a link to that page would be useful here.

rtyler · 2017-02-03T08:52:26Z

Considering the timezone different this week/weekend between @HRMPW and myself, I might take this pull request over and make the requested changes so we can publish it before end-of-day UTC.

@bitwiseman

I believe I have addressed all @bitwiseman's concerns

adding declarative blog, redirecting pipeline banner to new docs

eaeea0c

bitwiseman previously requested changes Feb 2, 2017

View reviewed changes

michaelneale reviewed Feb 2, 2017

View reviewed changes

michaelneale reviewed Feb 3, 2017

View reviewed changes

orrc suggested changes Feb 3, 2017

View reviewed changes

Copy and formatting edits

3ee3161

rtyler merged commit 11ad1f4 into jenkins-infra:master Feb 3, 2017

Adding declarative blog for GA release #581

Adding declarative blog for GA release #581

Conversation

HRMPW commented Feb 2, 2017

michaelneale commented Feb 2, 2017

HRMPW commented Feb 2, 2017

bitwiseman commented Feb 2, 2017

HRMPW commented Feb 2, 2017

bitwiseman 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

michaelneale commented Feb 2, 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

michaelneale commented Feb 3, 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

rtyler commented Feb 3, 2017