Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-343

Add Pipeline Best Practice Documentation for Jenkins.io

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      Based on the blog by Sam Van Oort we need to add a Pipeline handbook section for Best Practices. 

      We should start by recommending Declarative Pipeline for all Jenkinsfiles and Scripted Pipeline for Shared Libraries. Declarative wasn't part of Sam's blog but needs to be there.

      Other sections we should cover:

      • Using the 'replay' function for testing both in the UI and the CLI
      • Using the CLI Linter for Jenkinsfiles (could have a shell script that Lints the Jenkinsfile and then runs replay with Jenkinsfile for more rapid iteration)
      • Using Docker Pipeline correctly
      • Appendix list Groovy idioms that do not work and links to the JIRA for this.

        Attachments

          Issue Links

            Activity

            hrmpw Patrick Wolf created issue -
            hrmpw Patrick Wolf made changes -
            Field Original Value New Value
            Summary Add Pipeline Best Practice Documentat Add Pipeline Best Practice Documentation for Jenkins.io
            hrmpw Patrick Wolf made changes -
            Description Based on the [blog|https://jenkins.io/blog/2017/02/01/pipeline-scalability-best-practice] by [~svanoort] we need to add a Pipeline handbook section for Best Practices. 

            We should start by recommending Declarative Pipeline for all Jenkinsfiles and Scripted Pipeline for Shared Libraries. Declarative wasn't part of Sam's blog but needs to be there.

            Other sections we should cover:
             * [Using the 'replay' function|https://jenkins.io/blog/2016/04/14/replay-with-pipeline/] for testing both in the UI and the CLI
             * Using the CLI Linter for Jenkinsfiles (could have a shell script that Lints the Jenkinsfile and then runs replay with Jenkinsfile for more rapid iteration)
             * Using Docker Pipeline correctly
            Based on the [blog|https://jenkins.io/blog/2017/02/01/pipeline-scalability-best-practice] by [~svanoort] we need to add a Pipeline handbook section for Best Practices. 

            We should start by recommending Declarative Pipeline for all Jenkinsfiles and Scripted Pipeline for Shared Libraries. Declarative wasn't part of Sam's blog but needs to be there.

            Other sections we should cover:
             * [Using the 'replay' function|https://jenkins.io/blog/2016/04/14/replay-with-pipeline/] for testing both in the UI and the CLI
             * Using the CLI Linter for Jenkinsfiles (could have a shell script that Lints the Jenkinsfile and then runs replay with Jenkinsfile for more rapid iteration)
             * Using Docker Pipeline correctly
             * Appendix list Groovy idioms that do not work and links to the JIRA for this.
            rtyler R. Tyler Croy made changes -
            Link This issue relates to WEBSITE-296 [ WEBSITE-296 ]

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              hrmpw Patrick Wolf
              Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated: