Skip to content

Commit ecb780d

Browse files
Add Spotless plugin (#1435)
* add spotless-maven-plugin in the pom.xml * updated contribution guide * Update CONTRIBUTING.md Co-authored-by: Kris Stern <[email protected]> * removing unnecessary settings from pom.xml * adding cleaned files * Bump bom-2.361.x from 1945.v13a_1306588ff to 1948.veb_1fd345d3a_e --------- Co-authored-by: Kris Stern <[email protected]>
1 parent b83b6c3 commit ecb780d

14 files changed

+91
-72
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Before submitting your change make sure that:
1919
* you updated the help docs
2020
* you updated the README
2121
* you have used spotbugs to see if you haven't introduced any new warnings
22+
* you can run `mvn spotless:apply` to confirm that the code formatting is as expected
2223

2324
## Testing With Docker
2425

pom.xml

Lines changed: 88 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,9 @@
99
</parent>
1010
<artifactId>gitlab-plugin</artifactId>
1111
<version>${revision}${changelist}</version>
12+
<packaging>hpi</packaging>
1213
<name>GitLab Plugin</name>
1314
<url>https://github.com/jenkinsci/${project.artifactId}</url>
14-
<packaging>hpi</packaging>
15-
16-
<properties>
17-
<revision>1.7.10</revision>
18-
<changelist>-SNAPSHOT</changelist>
19-
<jenkins.version>2.375.4</jenkins.version>
20-
<spotbugs.effort>Max</spotbugs.effort>
21-
<spotbugs.threshold>Low</spotbugs.threshold>
22-
<gitHubRepo>jenkinsci/${project.artifactId}</gitHubRepo>
23-
<hpi.compatibleSinceVersion>1.4.0</hpi.compatibleSinceVersion>
24-
<mockserver.version>5.15.0</mockserver.version>
25-
</properties>
2615

2716
<licenses>
2817
<license>
@@ -39,6 +28,13 @@
3928
</developer>
4029
</developers>
4130

31+
<scm>
32+
<connection>scm:git:https://github.com/${gitHubRepo}.git</connection>
33+
<developerConnection>scm:git:[email protected]:${gitHubRepo}.git</developerConnection>
34+
<tag>${scmTag}</tag>
35+
<url>https://github.com/${gitHubRepo}</url>
36+
</scm>
37+
4238
<distributionManagement>
4339
<repository>
4440
<id>maven.jenkins-ci.org</id>
@@ -52,26 +48,39 @@
5248
</snapshotRepository>
5349
</distributionManagement>
5450

55-
<scm>
56-
<connection>scm:git:https://github.com/${gitHubRepo}.git</connection>
57-
<developerConnection>scm:git:[email protected]:${gitHubRepo}.git</developerConnection>
58-
<url>https://github.com/${gitHubRepo}</url>
59-
<tag>${scmTag}</tag>
60-
</scm>
61-
<!-- get every artifact through repo.jenkins-ci.org, which proxies all the artifacts that we need -->
62-
<repositories>
63-
<repository>
64-
<id>repo.jenkins-ci.org</id>
65-
<url>https://repo.jenkins-ci.org/public/</url>
66-
</repository>
67-
</repositories>
51+
<properties>
52+
<revision>1.7.10</revision>
53+
<changelist>-SNAPSHOT</changelist>
54+
<jenkins.version>2.375.4</jenkins.version>
55+
<spotbugs.effort>Max</spotbugs.effort>
56+
<spotbugs.threshold>Low</spotbugs.threshold>
57+
<gitHubRepo>jenkinsci/${project.artifactId}</gitHubRepo>
58+
<hpi.compatibleSinceVersion>1.4.0</hpi.compatibleSinceVersion>
59+
<mockserver.version>5.15.0</mockserver.version>
60+
</properties>
6861

69-
<pluginRepositories>
70-
<pluginRepository>
71-
<id>repo.jenkins-ci.org</id>
72-
<url>https://repo.jenkins-ci.org/public/</url>
73-
</pluginRepository>
74-
</pluginRepositories>
62+
<dependencyManagement>
63+
<dependencies>
64+
<dependency>
65+
<!-- Pick up common dependencies for the selected LTS line: https://github.com/jenkinsci/bom#usage -->
66+
<groupId>io.jenkins.tools.bom</groupId>
67+
<artifactId>bom-2.361.x</artifactId>
68+
<version>1948.veb_1fd345d3a_e</version>
69+
<type>pom</type>
70+
<scope>import</scope>
71+
</dependency>
72+
<!-- depdendencies added to satisfy new requirements from enforcer plugin in plugin pom 4.55 -->
73+
<dependency>
74+
<groupId>org.slf4j</groupId>
75+
<artifactId>slf4j-api</artifactId>
76+
</dependency>
77+
<dependency>
78+
<groupId>joda-time</groupId>
79+
<artifactId>joda-time</artifactId>
80+
<version>2.12.4</version>
81+
</dependency>
82+
</dependencies>
83+
</dependencyManagement>
7584

7685
<dependencies>
7786
<!-- Jenkins dependencies -->
@@ -305,32 +314,53 @@
305314
</exclusions>
306315
</dependency>
307316
</dependencies>
317+
<!-- get every artifact through repo.jenkins-ci.org, which proxies all the artifacts that we need -->
318+
<repositories>
319+
<repository>
320+
<id>repo.jenkins-ci.org</id>
321+
<url>https://repo.jenkins-ci.org/public/</url>
322+
</repository>
323+
</repositories>
308324

309-
<dependencyManagement>
310-
<dependencies>
311-
<dependency>
312-
<!-- Pick up common dependencies for the selected LTS line: https://github.com/jenkinsci/bom#usage -->
313-
<groupId>io.jenkins.tools.bom</groupId>
314-
<artifactId>bom-2.361.x</artifactId>
315-
<version>1948.veb_1fd345d3a_e</version>
316-
<scope>import</scope>
317-
<type>pom</type>
318-
</dependency>
319-
<!-- depdendencies added to satisfy new requirements from enforcer plugin in plugin pom 4.55 -->
320-
<dependency>
321-
<groupId>org.slf4j</groupId>
322-
<artifactId>slf4j-api</artifactId>
323-
</dependency>
324-
<dependency>
325-
<groupId>joda-time</groupId>
326-
<artifactId>joda-time</artifactId>
327-
<version>2.12.4</version>
328-
</dependency>
329-
</dependencies>
330-
</dependencyManagement>
325+
<pluginRepositories>
326+
<pluginRepository>
327+
<id>repo.jenkins-ci.org</id>
328+
<url>https://repo.jenkins-ci.org/public/</url>
329+
</pluginRepository>
330+
</pluginRepositories>
331331

332332
<build>
333333
<plugins>
334+
<plugin>
335+
<groupId>com.diffplug.spotless</groupId>
336+
<artifactId>spotless-maven-plugin</artifactId>
337+
<version>2.35.0</version>
338+
<configuration>
339+
<!-- define a language-specific format -->
340+
<java>
341+
<!-- no need to specify files, inferred automatically -->
342+
<endWithNewline />
343+
<removeUnusedImports />
344+
</java>
345+
<pom>
346+
<sortPom>
347+
<encoding>${project.build.sourceEncoding}</encoding>
348+
<lineSeparator>\n</lineSeparator>
349+
<expandEmptyElements>false</expandEmptyElements>
350+
<spaceBeforeCloseEmptyElement>true</spaceBeforeCloseEmptyElement>
351+
</sortPom>
352+
</pom>
353+
</configuration>
354+
<executions>
355+
<execution>
356+
<!-- Runs in verify phase by default -->
357+
<goals>
358+
<!-- Can be disabled using -Dspotless.check.skip -->
359+
<goal>check</goal>
360+
</goals>
361+
</execution>
362+
</executions>
363+
</plugin>
334364
<plugin>
335365
<artifactId>maven-enforcer-plugin</artifactId>
336366
<executions>
@@ -400,10 +430,10 @@
400430
<version>1.2</version>
401431
<executions>
402432
<execution>
403-
<phase>pre-integration-test</phase>
404433
<goals>
405434
<goal>allocate-ports</goal>
406435
</goals>
436+
<phase>pre-integration-test</phase>
407437
<configuration>
408438
<ports>
409439
<port>
@@ -488,19 +518,19 @@
488518
<executions>
489519
<execution>
490520
<id>start</id>
491-
<phase>pre-integration-test</phase>
492521
<goals>
493522
<goal>build</goal>
494523
<goal>start</goal>
495524
</goals>
525+
<phase>pre-integration-test</phase>
496526
</execution>
497527
<execution>
498528
<id>stop</id>
499-
<phase>post-integration-test</phase>
500529
<goals>
501530
<goal>stop</goal>
502531
<goal>remove</goal>
503532
</goals>
533+
<phase>post-integration-test</phase>
504534
</execution>
505535
</executions>
506536
</plugin>
@@ -512,10 +542,10 @@
512542
<executions>
513543
<execution>
514544
<id>add-source</id>
515-
<phase>generate-sources</phase>
516545
<goals>
517546
<goal>add-source</goal>
518547
</goals>
548+
<phase>generate-sources</phase>
519549
<configuration>
520550
<sources>
521551
<source>${basedir}/target/generated-sources</source>
@@ -524,10 +554,10 @@
524554
</execution>
525555
<execution>
526556
<id>add-test-source</id>
527-
<phase>generate-test-sources</phase>
528557
<goals>
529558
<goal>add-test-source</goal>
530559
</goals>
560+
<phase>generate-test-sources</phase>
531561
<configuration>
532562
<sources>
533563
<source>${basedir}/target/generated-test-sources</source>

src/main/java/com/dabsquared/gitlabjenkins/connection/GitLabCredentialMatcher.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ public boolean matches(@NonNull Credentials credentials) {
1919
return false;
2020
}
2121
}
22-
}
22+
}

src/main/java/com/dabsquared/gitlabjenkins/gitlab/api/impl/ResteasyGitLabClientBuilder.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848
import javax.ws.rs.core.MediaType;
4949
import javax.ws.rs.core.MultivaluedMap;
5050
import javax.ws.rs.ext.RuntimeDelegate;
51-
import java.io.ByteArrayInputStream;
5251
import java.io.IOException;
5352
import java.io.InputStream;
5453
import java.net.InetSocketAddress;

src/main/java/com/dabsquared/gitlabjenkins/gitlab/hook/model/MergeRequestChangedTitle.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
import org.apache.commons.lang.builder.HashCodeBuilder;
66
import org.apache.commons.lang.builder.ToStringBuilder;
77

8-
import java.util.List;
98

109
/**
1110
* @author Anton Johansson

src/main/java/com/dabsquared/gitlabjenkins/gitlab/hook/model/MergeRequestObjectAttributes.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
import org.apache.commons.lang.builder.ToStringBuilder;
77

88
import java.util.Date;
9-
import java.util.List;
109

1110
/**
1211
* @author Robin Müller

src/main/java/com/dabsquared/gitlabjenkins/trigger/handler/merge/MergeRequestHookTriggerHandlerFactory.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
import java.util.Set;
1414
import java.util.stream.Stream;
1515

16-
import org.apache.commons.lang.StringUtils;
1716

1817
/**
1918
* @author Robin Müller

src/main/java/com/dabsquared/gitlabjenkins/trigger/handler/merge/MergeRequestHookTriggerHandlerImpl.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
import com.dabsquared.gitlabjenkins.trigger.filter.MergeRequestLabelFilter;
99
import com.dabsquared.gitlabjenkins.trigger.handler.AbstractWebHookTriggerHandler;
1010
import com.dabsquared.gitlabjenkins.util.BuildUtil;
11-
import com.dabsquared.gitlabjenkins.trigger.handler.PendingBuildsHandler;
1211
import hudson.model.Job;
1312
import hudson.model.Run;
1413
import hudson.plugins.git.GitSCM;
@@ -19,7 +18,6 @@
1918

2019
import static java.util.Collections.emptyList;
2120
import static java.util.Collections.emptySet;
22-
import static java.util.stream.Collectors.toSet;
2321

2422
import java.util.ArrayList;
2523
import java.util.List;

src/main/java/com/dabsquared/gitlabjenkins/trigger/handler/pipeline/NopPipelineHookTriggerHandler.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
package com.dabsquared.gitlabjenkins.trigger.handler.pipeline;
22

33
import com.dabsquared.gitlabjenkins.gitlab.hook.model.PipelineHook;
4-
import com.dabsquared.gitlabjenkins.gitlab.hook.model.PushHook;
54
import com.dabsquared.gitlabjenkins.trigger.filter.BranchFilter;
65
import com.dabsquared.gitlabjenkins.trigger.filter.MergeRequestLabelFilter;
7-
import com.dabsquared.gitlabjenkins.trigger.handler.push.PushHookTriggerHandler;
86
import hudson.model.Job;
97

108
/**

src/main/java/com/dabsquared/gitlabjenkins/trigger/handler/pipeline/PipelineHookTriggerHandlerFactory.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package com.dabsquared.gitlabjenkins.trigger.handler.pipeline;
22

3-
import com.dabsquared.gitlabjenkins.gitlab.hook.model.State;
43

54
import java.util.ArrayList;
65
import java.util.List;

src/main/java/com/dabsquared/gitlabjenkins/util/CommitStatusUpdater.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import com.dabsquared.gitlabjenkins.cause.CauseData;
44
import com.dabsquared.gitlabjenkins.cause.GitLabWebHookCause;
5-
import com.dabsquared.gitlabjenkins.connection.GitLabConnection;
65
import com.dabsquared.gitlabjenkins.connection.GitLabConnectionProperty;
76
import com.dabsquared.gitlabjenkins.gitlab.api.GitLabClient;
87
import com.dabsquared.gitlabjenkins.gitlab.api.model.BuildState;

src/main/java/com/dabsquared/gitlabjenkins/webhook/build/PipelineBuildAction.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,3 @@ protected void performOnPost(GitLabPushTrigger trigger) {
8080
}
8181

8282
}
83-

src/test/java/com/dabsquared/gitlabjenkins/connection/GitLabConnectionConfigSSLTest.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package com.dabsquared.gitlabjenkins.connection;
22

33
import static org.hamcrest.CoreMatchers.containsString;
4-
import static org.hamcrest.CoreMatchers.is;
54
import static org.hamcrest.MatcherAssert.assertThat;
65

76
import com.cloudbees.plugins.credentials.CredentialsProvider;

src/test/java/com/dabsquared/gitlabjenkins/util/BuildUtilTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,4 +132,4 @@ private BuildData createBuildData(String sha) {
132132

133133
return buildData;
134134
}
135-
}
135+
}

0 commit comments

Comments
 (0)