{"id":1003,"date":"2024-08-27T16:45:32","date_gmt":"2024-08-27T16:45:32","guid":{"rendered":"https:\/\/blog.ngocha.biz\/?p=1003"},"modified":"2024-08-27T16:45:32","modified_gmt":"2024-08-27T16:45:32","slug":"setup-jenkins-email-notification","status":"publish","type":"post","link":"https:\/\/blog.ngocha.biz\/?p=1003","title":{"rendered":"How to Setup Jenkins Email Notification (Detailed Guide)"},"content":{"rendered":"

In this blog, you will learn about setting up Jenkins Email notification.<\/p>

Email notification for Jenkins build status is an important part each pipeline. It allows developers and relevant teams to get instance feedback on their pipeline job.<\/p>

SMTP Credentials (Prerequisite)<\/h2>

You need to have valid SMTP credentials to setup the email notification.<\/p>

If you are setting it up for your organisation, you can get the SMTP details from the network team.<\/p>

If you are using AWS you can make use of AWS SES to create SMTP credentials.<\/a><\/p>

Setup Jenkins Email Notification<\/h2>

Follow the steps below to set up the Jenkins Email notification.<\/p>

Step 1: Create Credentials of SMTP Username and Password<\/h3>

The first step is to create a Jenkins credential with SMTP username and password.<\/p>

Go to Manage Jenkins<\/strong> -> Credentials<\/strong> and create a global credential.<\/p>

\"creating<\/figure>

Select the credentials kind as Username with password and specify your SMTP username and password.<\/p>

\"creating<\/figure>

Then, press the Create<\/strong> button to create the credential.<\/p>

Step 2: Configure SMTP Server on Jenkins<\/h3>

The next step is to configure the SMTP server on Jenkins. For that, go to<\/p>

Manage Jenkins -><\/strong> System<\/strong> scroll down to the Jenkins Location<\/strong> section and enter your from address, which is your SMTP server’s name.<\/p>

\"enter<\/figure>

You have to specify the from address in the following format<\/p>

example@<smtp-server-name><\/code><\/pre>
For example, my SMTP server’s name is devopsprojects.dev<\/strong>, and I have given it as jenkins@devopsproject.dev<\/strong>.<\/p>
Now, scroll down to the Extended E-mail Notification <\/strong>section and specify your SMTP server address, port, select SSL and select the credentials you created in the previous step.<\/p>
\"configuring<\/figure>
Make sure you have given your SMTP server’s address and click the Save<\/strong> button to save the configurations.<\/p>
Step 3: Test Jenkins Email Notification on a Pipeline Job<\/h3>
Once the SMTP server is configured, you can add email notification on each job.<\/p>
An example Jenkins pipeline code<\/a> for email notification is given below (highlighted code).The post block is responsible<\/strong> for sending email notifications.<\/p>
pipeline {\n    agent {\n        label 'kubeagent'\n    }\n\n    stages {\n        stage('Code Checkout') {\n            steps {\n                sh \"echo 'Checkout Completed'\"\n            }\n        }\n        stage('Build') {\n            steps {\n                sh \"echo 'Build Completed'\"\n            }\n        }\n    }\n    post {\n        always {\n            mail to: 'aswin@crunchops.com',\n                 subject: \"Jenkins Build Notification: ${currentBuild.fullDisplayName}\",\n                 body: \"\"\"\\\n                 Build Status: ${currentBuild.currentResult}\n                 Project: ${env.JOB_NAME}\n                 Build Number: ${env.BUILD_NUMBER}\n                 Build URL: ${env.BUILD_URL}\n                 \"\"\"\n        }\n    }\n}\n<\/code><\/pre>
The label ‘kubeagent’<\/strong> on the agent block is the label of my agent make sure to replace it with your agent label.<\/p>
Also, make sure to update the email ID before starting the build.<\/p>
Now, Create a new pipeline using the above pipeline code.<\/p>
\"creating<\/figure>
Give a name to the job and select the type as Pipeline<\/p>
\"creating<\/figure>
On the next page, go to Advanced Project Options and paste the above pipeline code inside the script block<\/p>
\"creating<\/figure>
Once the Job is created click the Build now button to start the build<\/p>
\"triggering<\/figure>
You can see the build is successful<\/p>
\"output<\/figure>
And you will receive an email notification on the specified email as shown below<\/p>
\"email<\/figure>
Now, let’s see what happens if the build gets failed.<\/p>
I have added the following stage in the pipeline to fail the build.<\/p>
stage('Test') {\n    steps {\n        sh \"exit 1\"\n    }\n}<\/code><\/pre>
You will receive the below mail for failed build<\/p>
\"email<\/figure>
If you are using freestyle job, you can configure the email notification in the post build actions as shown below.<\/p>
\"email<\/figure>
Email Notification Using Shared Library<\/h2>
Follow that steps given below to setup email notification using Jenkins shared library<\/a>.<\/p>
Step 1: Configure Jenkins Shared Library<\/h3>
We will be using the shared library in the pipeline, you can find the script in the following GitHub repository.<\/p>
https:\/\/github.com\/techiescamp\/jenkins-shared-library<\/code><\/pre>
If you already have a shared library, you can make use of the EmailNotification Function<\/a> and the related HTML template<\/a> from the resources folder.<\/p>
If you want to use our shared library repo, follow the below steps to configure it.<\/p>
Go to Manage Jenkins –> System<\/strong> and scroll down to the Global Trusted Pipeline Libraries<\/strong> section and configure shared library as shown below<\/p>
\"configuring<\/figure>
\"configuring<\/figure>
Step 2: Test Jenkins Email Notification with Shared Library<\/h3>
An example pipeline code for email notification is given below<\/p>
@Library('jenkins-shared-library@master') _\npipeline {\n    agent {\n        label 'kubeagent'\n    }\n\n    stages {\n        stage('Git Checkout') {\n            steps {\n                sh \"echo 'Checkout Completed'\"\n            }\n        }\n        stage('Build') {\n            steps {\n                sh \"echo 'Build Completed'\"\n            }\n        }\n    }\n    post {\n        always {\n            script {\n                emailNotification(\"aswin@crunchops.com\")\n            }\n        }\n    }\n}<\/code><\/pre>
Make sure to update the Email ID before starting the build.<\/p>
The groovy script for email notification and its template is placed inside the following directory<\/p>
\u251c\u2500\u2500 resources\n\u2502       \u2514\u2500\u2500 notify.tpl\n\u251c\u2500\u2500 src\n\u2514\u2500\u2500 vars\n      \u2514\u2500\u2500 emailNotification.groovy<\/code><\/pre>
The groovy script uses the notify.tpl<\/strong> template in the resource folder, you can get the directory structure and code used in this lesson from Github<\/a>.<\/p>
Create a pipeline with above pipeline code, and once the build is completed, you will receive an email notification on the specified email as shown below<\/p>
\"email<\/figure>
And, this is the notification you will get for a failed build.<\/p>
\"email<\/figure>
You can see that the URL for the build, the branch, and the build details are given directly in the email notification itself.<\/p>
Troubleshooting Jenkins Email Notification<\/h2>
The following are the common reasons why your Email notification is not sent properly after every build.<\/p>\n\n
    \n
  1. Check the SMTP configuration you did on the Email notification setup step 2<\/strong>. Check if the from address (System Admin e-mail address), SMTP server address, and port are correct.<\/li>\n\n\n
  2. Check if the SMTP server credentials stored in the Jenkins credentials are correct, and make sure you are using the correct credentials in the SMTP configuration.<\/li>\n\n\n
  3. Make sure you have defined the Post Build Action block<\/strong> in the pipeline correctly.<\/li>\n\n\n
  4. Check if the correct recipient Email<\/strong> is given in the pipeline.<\/li>\n\n\n
  5. The SMTP port you are using may be blocked in the security group<\/strong> of the Jenkins server.<\/span> Make sure to allow the port required to connect with the SMTP server, in our case it\u2019s port 465<\/strong>.<\/li>\n\n\n
  6. You may receive your Email, but it’s in spam. Check if your SMTP server is configured with DKIM (Domain Keys Identified Mail)<\/strong> and SPF (Sender Policy Framework)<\/strong>.<\/li>\n<\/ol>\n\n
    Conclusion<\/h2>
    In this blog, you have learned about setting up Jenkins Email notifications and tested it on a pipeline job.<\/p>
    Also, you have learned about setting up Jenkins shared library and using it to send Email notifications.<\/p>\n
    Ngu\u1ed3n:<\/strong> How to Setup Jenkins Email Notification (Detailed Guide) \u2014 DevOpsCube<\/a><\/p>","protected":false},"excerpt":{"rendered":"
    Source: https:\/\/devopscube.com\/setup-jenkins-email-notification\/<\/p>\n","protected":false},"author":1,"featured_media":1004,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-1003","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-devops"],"_links":{"self":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/1003","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1003"}],"version-history":[{"count":0,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/1003\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/media\/1004"}],"wp:attachment":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1003"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1003"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1003"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}