{"id":62205,"date":"2024-06-06T17:15:58","date_gmt":"2024-06-06T11:45:58","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=62205"},"modified":"2024-06-06T17:18:29","modified_gmt":"2024-06-06T11:48:29","slug":"pro-jenkinsfile-avoid-these-common-ci-cd-mistakes-part-1","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/pro-jenkinsfile-avoid-these-common-ci-cd-mistakes-part-1\/","title":{"rendered":"Pro Jenkinsfile: Avoid These Common Mistakes \u2013 Part 1"},"content":{"rendered":"

Introduction<\/b><\/span><\/h2>\n

Hello, DevOps Engineers! Uncle Jenkins here, your trusty CI\/CD butler, ready to help you master the art of writing Jenkinsfiles. Just as a butler ensures everything in the household runs smoothly, I’m here to ensure your CI\/CD pipelines are efficient and error-free.\u00a0<\/span>Let’s dive into some common pitfalls you might face and, more importantly, how to get them right. Let’s get started!
\n<\/span><\/span><\/p>\n

\"Jenkins

Jenkins logo<\/span><\/p><\/div>\n

Not Using Declarative Syntax: Keep It Simple, Silly!<\/b><\/span><\/h2>\n

Declarative syntax in Jenkinsfiles is like the gold standard: clear, concise, and easy to work with. Opting for declarative syntax instead of scripted pipelines can prevent confusion and streamline your CI\/CD workflows.
\n<\/span><\/p>\n

\"Jenkins

Jenkins Pipeline<\/span><\/p><\/div>\n


\n<\/span>Tip<\/b>: Use the declarative syntax whenever possible. Here’s a quick example:<\/span><\/span><\/p>\n\n\n\n
pipeline {<\/span>
\n\u00a0 \u00a0 agent any<\/span>
\n \u00a0 \u00a0 \u00a0 stages {<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 stage(‘Build’) {<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 echo ‘Building..’<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 stage(‘Test’) {<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 echo ‘Testing..’<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 stage(‘Deploy’) {<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 echo ‘Deploying..’<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n\u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n\u00a0 \u00a0 \u00a0 }<\/span>
\n}<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Hardcoding Credentials: A Recipe for Disaster<\/b><\/span><\/h2>\n

Hardcoding credentials in your Jenkinsfile is like leaving the front door unlocked\u2014not very secure! This practice can lead to security vulnerabilities and make it difficult to manage secrets.
\n<\/span>Avoidance Tip<\/b>: Use Jenkins credentials management to handle sensitive information securely. You can then reference these credentials in your Jenkinsfile:<\/span><\/span><\/p>\n\n\n\n
pipeline {<\/span>
\n<\/span>\u00a0 \u00a0 agent any<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 stage(<\/span>‘Deploy’<\/span>) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 script {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Using withCredentials to access stored credentials<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 withCredentials([usernamePassword(credentialsId: <\/span>‘my-credentials-id’<\/span>, usernameVariable: <\/span>‘USERNAME’<\/span>, passwordVariable: <\/span>‘PASSWORD’<\/span>)]) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>echo<\/span> “Deploying with credentials”<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sh <\/span>“””<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 # Using the credentials in shell commands<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 curl -u <\/span>$USERNAME<\/span>:<\/span>$PASSWORD<\/span> -X POST http:\/\/example.com\/deploy<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “””<\/span>
\n<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span> \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 }<\/span>
\n<\/span>}<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Ignoring Error Handling: Don\u2019t Leave It to Chance<\/b><\/span><\/h2>\n

Pipelines fail. It\u2019s a fact. Ignoring error handling means you’ll be unprepared when things go wrong, costing you time and resources.
\n<\/span>Avoidance Tip<\/b>: Use try-catch blocks and the post section to manage errors and ensure proper cleanup.<\/span><\/span><\/p>\n\n\n\n
pipeline {<\/span>
\n<\/span>\u00a0 \u00a0 agent any<\/span>
\n<\/span>\u00a0 \u00a0 stages {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 stage(<\/span>‘Build’<\/span>) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 script {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 try {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sh <\/span>‘.\/build.sh’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 } catch (hudson.AbortException e) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>echo<\/span> “Build aborted: <\/span>${e.message}<\/span>“<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 error(<\/span>“Stopping the pipeline due to build abortion.”<\/span>)<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 } catch (IOException e) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>echo<\/span> “Build failed due to I\/O error: <\/span>${e.message}<\/span>“<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 error(<\/span>“Stopping the pipeline due to I\/O error.”<\/span>)<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 } finally {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>echo<\/span> ‘Cleaning up…’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 cleanWs()<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 }<\/span>
\n<\/span>}<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Ignoring Workspace Cleanup: Don\u2019t Be a Hoarder<\/b><\/span><\/h2>\n

Unused files cluttering your workspace can cause builds to fail. Clean up after yourself.
\n<\/span><\/p>\n

\"Clean

Clean workspace<\/span><\/p><\/div>\n

Avoidance Tip<\/b>: Use the cleanWs step to clean the workspace after build.<\/span><\/span><\/p>\n\n\n\n
pipeline {<\/span>
\n<\/span> \u00a0 \u00a0 agent any<\/span>
\n<\/span> \u00a0 \u00a0 stages {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 stage(<\/span>‘Build’<\/span>) {<\/span>
\n<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sh <\/span>‘make build’<\/span>
\n<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span> \u00a0 \u00a0 }<\/span>
\n<\/span> \u00a0 \u00a0 post {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 always {<\/span>
\n<\/span> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 cleanWs()<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span> \u00a0 \u00a0 }<\/span>
\n<\/span>}<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Not using Parallelism: Speed Up Your Pipeline<\/b><\/span><\/h2>\n

Running tasks sequentially that could run in parallel wastes time.
\n<\/span>Avoidance Tip<\/b>: Use the parallel step to run tasks concurrently.<\/span><\/span><\/p>\n\n\n\n
pipeline {<\/span>
\n<\/span>\u00a0 \u00a0 agent any<\/span>
\n<\/span>\u00a0 \u00a0 stages {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 stage(<\/span>‘Test’<\/span>) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 parallel failFast: <\/span>true<\/span>, stages: {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 stage(<\/span>‘Unit Test’<\/span>) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>echo<\/span> ‘Running unit tests..’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 stage(<\/span>‘Integration Test’<\/span>) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>echo<\/span> ‘Running integration tests..’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 }<\/span>
\n<\/span>}<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/span>Key Points:<\/b><\/span><\/h4>\n
    \n
  • Parallel Block with failFast<\/b>: The failFast parameter is true in the parallel block. If either the “Unit Test” or “Integration Test” stage fails, the other parallel stage is immediately halted, and the pipeline progresses to any post-failure handling without wasting time or resources on a build that\u2019s already known to have issues.<\/span><\/span><\/li>\n
  • Immediate Feedback<\/b>: This setup ensures that any failure in the testing phase is immediately caught and addressed, speeding up the development cycle by reducing the wait time for feedback.<\/span><\/span><\/li>\n<\/ul>\n

    Neglecting to Use Jenkins Shared Library for Reusable Code: Simplify and Standardize<\/b><\/span><\/h2>\n

    Duplicated code is error-prone and difficult to maintain. Jenkins Shared Libraries help you<\/span> DRY (Don\u2019t Repeat Yourself)<\/b>.
    \n<\/span><\/span><\/p>\n

    \"shared

    shared library<\/p><\/div>\n

    Avoidance Tip<\/b>:<\/b> Using shared libraries to encapsulate common logic.<\/span><\/p>\n\n\n\n
    @Library(<\/span>‘jenkins-shared-library’<\/span>) _<\/span>
    \n<\/span>pipeline {<\/span>
    \n<\/span>\u00a0 \u00a0 agent any<\/span>
    \n<\/span>\u00a0 \u00a0 stages {<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 stage(<\/span>‘Build’<\/span>) {<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Using a custom <\/span>function<\/span> from the shared library<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 customBuildFunction()<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
    \n<\/span>\u00a0 \u00a0 }<\/span>
    \n<\/span>}<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    Conclusion<\/b><\/span><\/h3>\n

    Mastering Jenkinsfile creation is important for optimizing CI\/CD pipelines. Avoiding common pitfalls and adopting best practices can significantly enhance pipeline efficiency. Consider connecting with TO THE NEW<\/strong> for further support and expertise, especially in managing complex CI\/CD tasks<\/span>. Our team of <\/span>AWS Certified Architects & DevOps Engineers <\/b>can assist in streamlining your operations, offering services from migration to managed cloud solutions to disaster recovery, and ensuring your CI\/CD pipelines are as efficient and resilient as possible. <\/span>We still need to discuss more points regarding how to write a professional Jenkinsfile. Stay tuned for the next blog, covering additional strategies and insights to help you master Jenkinsfile creation and further improve your CI\/CD practices.<\/span><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

    Introduction Hello, DevOps Engineers! Uncle Jenkins here, your trusty CI\/CD butler, ready to help you master the art of writing Jenkinsfiles. Just as a butler ensures everything in the household runs smoothly, I’m here to ensure your CI\/CD pipelines are efficient and error-free.\u00a0Let’s dive into some common pitfalls you might face and, more importantly, how […]<\/p>\n","protected":false},"author":1601,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":50},"categories":[2348],"tags":[5983,4252,1892,1682,5982],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/62205"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1601"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=62205"}],"version-history":[{"count":15,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/62205\/revisions"}],"predecessor-version":[{"id":62253,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/62205\/revisions\/62253"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=62205"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=62205"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=62205"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}