Outdated - I haven’t used Jenkins for my CI in years.
Features:
- Records all environment variables
- Aborts if attempting to build a SNAPSHOT version on either the
master branch or a pull request onto the master branch
- Perform Static Code Analysis with checkstyle and pmd if there are Java source files - will fail if plugins are not available
- Performs a test build/install with Java 9 to validate compatibility
- Performs build/install with Java 8 for deploy candidate
- Records test results and code coverage in Jenkins if tests were run by surefire/failsafe
- Publishes code coverage to Codacy if tests were run by surefire/failsafe - see helpers below
- Archives any jar file created
- Deploy if on master branch and is attached to a remote git repo (i.e. not a local file:/ repo).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
final String mvn = "mvn --batch-mode --update-snapshots"
pipeline {
agent any
stages {
stage('Environment') {
steps {
sh 'set'
}
}
stage('no SNAPSHOT in master') {
// checks that the pom version is not a snapshot when the current or target branch is master
when {
expression {
(env.GIT_BRANCH == 'master' || env.CHANGE_TARGET == 'master') &&
(readMavenPom(file: 'pom.xml').version).contains("SNAPSHOT")
}
}
steps {
error("Build failed because SNAPSHOT version")
}
}
stage('Static Code Analysis') {
when { expression { findFiles(glob: '**/src/main/java/*.java').length > 0 } }
steps {
withMaven(maven: 'maven 3.5.2', jdk: 'JDK 1.8') {
sh "${mvn} compile checkstyle:checkstyle pmd:pmd"
}
pmd canComputeNew: false, defaultEncoding: '', healthy: '', pattern: '', unHealthy: ''
}
}
stage('Build Java 9') {
steps {
withMaven(maven: 'maven 3.5.2', jdk: 'JDK 9') {
sh "${mvn} clean install"
}
}
}
stage('Build Java 8') {
steps {
withMaven(maven: 'maven 3.5.2', jdk: 'JDK 1.8') {
sh "${mvn} clean install"
}
}
}
stage('Test Results') {
when { expression { findFiles(glob: '**/target/surefire-reports/*.xml').length > 0 } }
steps {
junit '**/target/surefire-reports/*.xml'
jacoco exclusionPattern: '**/*{Test|IT|Main|Application|Immutable}.class'
withMaven(maven: 'maven 3.5.2', jdk: 'JDK 1.8') {
sh "${mvn} com.gavinmogan:codacy-maven-plugin:coverage " +
"-DcoverageReportFile=target/site/jacoco/jacoco.xml " +
"-DprojectToken=`$JENKINS_HOME/codacy/token` " +
"-DapiToken=`$JENKINS_HOME/codacy/apitoken` " +
"-Dcommit=`git rev-parse HEAD`"
}
}
}
stage('Archiving') {
when { expression { findFiles(glob: '**/target/*.jar').length > 0 } }
steps {
archiveArtifacts '**/target/*.jar'
}
}
stage('Deploy') {
when { expression { (env.GIT_BRANCH == 'master' && env.GIT_URL.startsWith('https://')) } }
steps {
withMaven(maven: 'maven 3.5.2', jdk: 'JDK 1.8') {
sh "${mvn} deploy --activate-profiles release -DskipTests=true"
}
}
}
}
}
|
Codacy
Publishing to Codacy requires having a secret API Token and a Repo Token. Neither of these should be added to the Jenkinsfile. Instead the two scripts here are interpolated into the maven command line that invokes the codacy-maven-plugin in the Test Results stage.
Requirements: xpath
sudo apt install libxml-xpath-perl
token
1
2
3
4
5
6
|
#!/usr/bin/env bash
TOKENS_FILE=`dirname $0`/tokens
ARTIFACT_ID=`xpath -q -e "/project/artifactId/text()" < pom.xml`
grep "^${ARTIFACT_ID}=" ${TOKENS_FILE}|cut -d= -f2
|
tokens
Provides the repo token by searching for it in the text file tokens. e.g.
1
2
|
repo1=repo1key
repo2=repo2key
|
These would match against the artifactId of the root module pom.xml.
apitoken
Simply echos the apikey to STDOUT.
1
2
3
|
#!/usr/bin/env bash
echo "xxxXXXxxxXXXxxxXXXxxx"
|