{"id":62261,"date":"2024-06-27T17:57:21","date_gmt":"2024-06-27T12:27:21","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=62261"},"modified":"2024-06-27T18:45:47","modified_gmt":"2024-06-27T13:15:47","slug":"pro-jenkinsfile-avoid-these-common-mistakes-part-2","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/pro-jenkinsfile-avoid-these-common-mistakes-part-2\/","title":{"rendered":"Pro Jenkinsfile: Avoid These Common Mistakes \u2013 Part 2"},"content":{"rendered":"

Introduction
\n<\/b><\/span>Hello again, DevOps Engineers! Uncle Jenkins is back, ready to dive deeper into the world of Jenkinsfiles. Our previous blog covered some important tips to avoid common CI\/CD pitfalls. If you missed it, check out <\/span>Part 1<\/span><\/a> of this series to catch up on those crucial points. In this blog, we’ll explore more advanced strategies to refine and optimize your Jenkinsfiles. <\/span>Let’s continue our journey towards mastering Jenkinsfile creation. Ready to level up? Let’s get started!
\n<\/span><\/span><\/p>\n

\"Jenkin-logo\"

Jenkin-logo<\/span><\/p><\/div>\n

1.\u00a0 Ignoring Environment Variables: Don’t Hardcode Values<\/b><\/span><\/p>\n

Hardcoding values make your pipeline inflexible and difficult to maintain.
\n<\/span><\/span>Avoidance Tip<\/b><\/span>: Use the <\/span>environment<\/span> <\/a>directive to set variables and the <\/span>withCredentials<\/span><\/a> blocks to <\/span>manage configurations and secrets.<\/span><\/span><\/p>\n\n\n\n
pipeline {<\/span>
\n<\/span>\u00a0 \u00a0 agent any<\/span>
\n<\/span>\u00a0 \u00a0 environment {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 APP_ENV = <\/span>‘prod’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 API_ENDPOINT = <\/span>‘https:\/\/api.example.com’<\/span>
\n<\/span>\u00a0 \u00a0 }<\/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 <\/span>echo<\/span> “Building application for <\/span>${env.APP_ENV}<\/span>“<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 }<\/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 withCredentials([string(credentialsId: <\/span>‘aws-credentials-id’<\/span>, variable: <\/span>‘AWS_CREDENTIALS’<\/span>)]) {<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>echo<\/span> “Deploying to <\/span>${env.APP_ENV}<\/span> using <\/span>${env.API_ENDPOINT}<\/span>“<\/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><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

2. Stashing and Unstashing Artifacts<\/b><\/span><\/span><\/h2>\n

Common Mistakes:<\/span>
\n<\/span><\/span>– Overuse of stash and unstash: Excessive use can lead to unnecessary resource usage and complexity.
\n<\/span>– Naming Collisions: Using non-unique names for stashes can lead to unexpected behaviors.
\n<\/span>– Size Limitations: Not considering the size of stashed files, can lead to performance issues.<\/span><\/p>\n

Best Practices<\/span>:
\n<\/span>– Use stash and unstash for small, critical artifacts that need to be transferred between stages.
\n<\/span>– Ensure unique and meaningful names for each stash to avoid collisions.
\n<\/span>– Be mindful of the size and frequency of stashed content.<\/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 sh <\/span>‘echo “Build artifact” > artifact.txt’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 stash includes: <\/span>‘artifact.txt’<\/span>, name: <\/span>‘build-artifact’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 }<\/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 unstash <\/span>‘build-artifact’<\/span>
\n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sh <\/span>‘echo “Deploying artifact:” && cat artifact.txt’<\/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

3. Overusing sh Steps for Shell Commands: Keep it Clean<\/b><\/span><\/p>\n

Using sh steps everywhere makes your Jenkinsfile look like a tangled mess of shell scripts.<\/span>
\n<\/span>
\nAvoidance Tip<\/span>:<\/b> Use built-in Jenkins steps and plugins whenever possible. Reserve sh steps for when you truly need to execute shell commands. Example:
\nInstead of this:
\n<\/span><\/span><\/p>\n\n\n\n
pipeline {<\/b>
\n<\/b> \u00a0 agent any<\/b>
\n<\/b> \u00a0 stages {<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 stage(<\/b>‘Build’<\/b>) {<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/b>
\n<\/b>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sh <\/b>‘cp src\/* output\/’<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sh <\/b>‘gradle build’<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 }<\/b>
\n<\/b> \u00a0 }<\/b>
\n<\/b>}<\/b><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Keep it clean like this:<\/span><\/p>\n\n\n\n
pipeline {<\/b>
\n<\/b> \u00a0 agent any<\/b>
\n<\/b> \u00a0 stages {<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 stage(<\/b>‘Build’<\/b>) {<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 steps {<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sh <\/b>”’<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 cp src\/* output\/<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 gradle build<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 ”’<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/b>
\n<\/b> \u00a0 \u00a0 \u00a0 }<\/b>
\n<\/b> \u00a0 }<\/b>
\n<\/b>}<\/b><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

4. Ignoring Pipeline as Code Best Practices<\/b><\/p>\n

Not treating your Jenkinsfile with the same care as other code can lead to issues. This includes not version controlling your Jenkinsfile, not reviewing changes through pull requests, and not testing changes thoroughly.
\n<\/span>
\nAvoidance Tip<\/span>:<\/b><\/span><\/p>\n