Skip to content

Commit ef61b8c

Browse files
headiusheadius
committed
Hide javadoc, sources, and GPG behind -Prelease
GPG signing fails anywhere that isn't set up for it, so it should only run when releasing. The others are just generally unnecessary.
1 parent 31f308a commit ef61b8c

2 files changed

Lines changed: 71 additions & 42 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,25 @@ running the intergration tests
117117
mvn clean install -Pintegration-test -Pall
118118
```
119119

120+
releasing
121+
---------
122+
123+
Snapshots can be deployed with appropriate credentials when the versions
124+
are `-SNAPSHOT` using:
125+
126+
```
127+
mvn clean deploy
128+
```
129+
130+
When the versions are set to a release number (not `-SNAPSHOT`), the same
131+
command can be used to push a release with the `-Prelease` flag that
132+
enables javadoc, sources, and GPG signing:
133+
134+
```
135+
mvn clean deploy -Prelease
136+
```
137+
138+
See the [Maven Central guide](https://central.sonatype.org/publish/publish-portal-guide/) for more information.
120139

121140
contributing
122141
------------

‎pom.xml‎

Lines changed: 52 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -153,51 +153,61 @@
153153
<publishingServerId>central</publishingServerId>
154154
</configuration>
155155
</plugin>
156-
<plugin>
157-
<artifactId>maven-gpg-plugin</artifactId>
158-
<version>1.6</version>
159-
<executions>
160-
<execution>
161-
<id>sign-artifacts</id>
162-
<phase>verify</phase>
163-
<goals>
164-
<goal>sign</goal>
165-
</goals>
166-
</execution>
167-
</executions>
168-
<configuration>
169-
<gpgArguments>
170-
<gpgArgument>--pinentry-mode</gpgArgument>
171-
<gpgArgument>loopback</gpgArgument>
172-
</gpgArguments>
173-
</configuration>
174-
</plugin>
175-
<plugin>
176-
<artifactId>maven-javadoc-plugin</artifactId>
177-
<executions>
178-
<execution>
179-
<id>attach-javadocs</id>
180-
<goals>
181-
<goal>jar</goal>
182-
</goals>
183-
</execution>
184-
</executions>
185-
<configuration>
186-
<doclint>none</doclint>
187-
</configuration>
188-
</plugin>
189-
<plugin>
190-
<artifactId>maven-source-plugin</artifactId>
191-
<version>3.2.1</version>
192-
<executions>
193-
<execution>
194-
<goals><goal>jar</goal></goals>
195-
</execution>
196-
</executions>
197-
</plugin>
198156
</plugins>
199157
</build>
200158

159+
<profiles>
160+
<profile>
161+
<id>release</id>
162+
<build>
163+
<plugins>
164+
<plugin>
165+
<artifactId>maven-gpg-plugin</artifactId>
166+
<version>1.6</version>
167+
<executions>
168+
<execution>
169+
<id>sign-artifacts</id>
170+
<phase>verify</phase>
171+
<goals>
172+
<goal>sign</goal>
173+
</goals>
174+
</execution>
175+
</executions>
176+
<configuration>
177+
<gpgArguments>
178+
<gpgArgument>--pinentry-mode</gpgArgument>
179+
<gpgArgument>loopback</gpgArgument>
180+
</gpgArguments>
181+
</configuration>
182+
</plugin>
183+
<plugin>
184+
<artifactId>maven-javadoc-plugin</artifactId>
185+
<executions>
186+
<execution>
187+
<id>attach-javadocs</id>
188+
<goals>
189+
<goal>jar</goal>
190+
</goals>
191+
</execution>
192+
</executions>
193+
<configuration>
194+
<doclint>none</doclint>
195+
</configuration>
196+
</plugin>
197+
<plugin>
198+
<artifactId>maven-source-plugin</artifactId>
199+
<version>3.2.1</version>
200+
<executions>
201+
<execution>
202+
<goals><goal>jar</goal></goals>
203+
</execution>
204+
</executions>
205+
</plugin>
206+
</plugins>
207+
</build>
208+
</profile>
209+
</profiles>
210+
201211
<properties>
202212
<root.dir>${basedir}</root.dir>
203213
<gem.home>${root.dir}/target/rubygems</gem.home>

0 commit comments

Comments
 (0)