This repository is for the Build a Java app with Maven tutorial in the Jenkins User Documentation.
The repository contains a simple Java application which outputs the string "Hello world!" and is accompanied by a couple of unit tests to check that the main application works as expected. The results of these tests are saved to a JUnit XML report.
The jenkins directory contains an example of the Jenkinsfile (i.e. Pipeline)
you'll be creating yourself during the tutorial and the jenkins/scripts subdirectory
contains a shell script with commands that are executed when Jenkins processes
the "Deliver" stage of your Pipeline.
There are 2 plugins to send email notification. Email Notification and Extended Email. We will prefer to use Email extended as it provides more features and control on Email notification.
Follow below steps to configure and send email notification
For integrating google email with jenkins, we need to generate a App password. The normal password for gmail will not work with integration. To generate google app password, we need to enable 2 MFA. Please follow below steps to generate a app password.
- Navigate to Google account --> Profile Pic --> Manage Account
- Select Security and Enable 2 factor authentication if you have not done it
○ You can follow instruction and choose different option instead of phone number
○ It will give you option to prompt on your device after login
○ If you device doesn't appear on page, then Add your google account in your mobile phone
- Once 2MFA is enable navigate back to security Tab and click on 2 Step Verification in Right Pane
- On bottom of the page you will find App Password
- Create a new App password for Jenkins
Navigate to Manage Jenkins--> System--> Extended Email and add following details
smtp server : smtp.gmail.com
Smtp port : 465
- Advance
□ Add Credentials for Google username and App password generated above
□ Use SSL
Default user email suffix : @gmail.com
ListID : Leave it blank
Default Recipients : ****@gmail.com
Reply To List : [email protected]
Leave everything as Default
Chose Appropriate Default Triggers
Navigate to Manage Jenkins--> System--> Email Notification and add following details
smtp server : smtp.gmail.com
Default user email suffix : @gmail.com
- Advance
Use SMTP Authentication
Add Credentials for Google username and App password generated above
Use SSL
SMTP Port : 465
Reply To List : [email protected]
Charset : UTF-8 (by default it is UTF-8)
Test e-mail recipient : <enter recipient email id >
- Add Extended Email as post Build action to receive emails
- Select Always Triggers
To send Slack notifications from Jenkins, you can use the "Slack Notification" plugin. We will configuration at both end Slack and Jenkins. In slack we will need to setup an app and generates token for it. This token will be used in Jenkins to connect with Slack and send notification.
1. Create a Slack account if you don't have one. Set up a Slack workspace if you haven't already.
2. To create an app in slack you have required permissions, otherwise you will not be able to see app options
3. Navigate to workspace in Slack-->Settings & adminstration--> Manage apps
4. Click on Build button on top right corner of the page, to create a new App
5. Click on Create New App --> From Scratch --> Provide your prefered name and select your worksace --> Create App
6. You will be landed on the Basic Information page, navigate to "OAuth & Permissions" menu item on left pane
7. On OAuth & Permissions page, under User Token Scope --> click on Add an OAuth Scope
8. Type and select chat:write
9. On top of same page, under section "OAuth Tokens for your workspace" --> click on "Install to workspace" button to generate token
10. Click Allow
11. On slack workspace add a public channel as "Notification"
OR
We can add a existing Jenkins CI app.
1. Navigate to workspace in Slack-->Settings & adminstration--> Manage apps
2. Search "Jenkins CI" in the search App Directory box on top of the page
3. Click on Add to Slack button
4. Choose channel from the dropdown box --> Click on Add Jenkins Ci Integration
1. Install "Slack Notification" plugin
2. Navigate to Manage Jenkins --> System
3. Under Slack section, Add workspace name. The workspace name can find from your workspace url, like if your workspace url is https://training-7u81625.slack.com, then your workspace name will be training-7u81625
4. Add your slack token, generated above, as secret text credentials in Jenkins
5. Specify channel name, created above.
12. Check the checkbox "Custom slack app bot user"
13. Apply and Save
1. Add a PostBuild Action --> Select Slack notification
2. Check "Notify Build Start" & "Notify Success" --> Apply & Save
That's it! You should now have Jenkins configured to send Slack notifications for your builds.