Skip to content

Commit 72ad6b7

Browse files
fvarruifvarrui
committed
U docs
1 parent 5d73870 commit 72ad6b7

File tree

2 files changed

+60
-21
lines changed

2 files changed

+60
-21
lines changed

‎README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,13 @@ JavaPackager is a Maven plugin which provides an easy way to package Java applic
55

66
### Config your project
77

8-
Add to your `pom.xml` the following `pluginRepository` tag:
9-
10-
```xml
11-
<pluginRepository>
12-
<id>javapackager</id>
13-
<url>https://github.com/fvarrui/JavaPackager/raw/master/releases</url>
14-
</pluginRepository>
15-
```
16-
17-
And the following `plugin` tag.
8+
Add the following `plugin` tag to your `pom.xml`:
189

1910
```xml
2011
<plugin>
21-
<groupId>fvarrui.maven</groupId>
22-
<artifactId>javapackager</artifactId>
23-
<version>0.8.9</version>
12+
<groupId>io.github.fvarrui</groupId>
13+
<artifactId>javapackager</artifactId>
14+
<version>0.9.0</version>
2415
<executions>
2516
<execution>
2617
<phase>package</phase>
@@ -195,12 +186,23 @@ cd JavaPackager
195186
mvn install
196187
```
197188

189+
## How to publish the plugin on Maven Central
190+
191+
```bash
192+
mvn clean
193+
mvn release:prepare
194+
mvn release:perform
195+
```
196+
197+
> Related [guide](https://dzone.com/articles/publish-your-artifacts-to-maven-central).
198+
198199
## Future features
199200

200201
Check the [TO-DO list](https://github.com/fvarrui/JavaPackager/projects/1#column-7704117) to know the features we plan to add to JavaPackager.
201202

202203
## Older documentation
203204

205+
- [v0.8.9](https://github.com/fvarrui/JavaPackager/blob/v0.8.9/README.md)
204206
- [v0.8.8](https://github.com/fvarrui/JavaPackager/blob/v0.8.8/README.md)
205207
- [v0.8.7](https://github.com/fvarrui/JavaPackager/blob/v0.8.7/README.md)
206208
- [v0.8.6](https://github.com/fvarrui/JavaPackager/blob/v0.8.6/README.md)

‎docs/plugin-configuration-samples.md

+45-8
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
```xml
66
<plugin>
7-
<groupId>fvarrui.maven</groupId>
7+
<groupId>io.github.fvarrui</groupId>
88
<artifactId>javapackager</artifactId>
99
<version>{latest-plugin-version-here}</version>
1010
<executions>
@@ -31,7 +31,7 @@ Also, JavaPackager plugin is able to get some properties from `pom.xml`, so you
3131
<build>
3232
<plugins>
3333
<plugin>
34-
<groupId>fvarrui.maven</groupId>
34+
<groupId>io.github.fvarrui</groupId>
3535
<artifactId>javapackager</artifactId>
3636
<version>{latest-plugin-version-here}</version>
3737
<executions>
@@ -53,7 +53,7 @@ Also, JavaPackager plugin is able to get some properties from `pom.xml`, so you
5353

5454
```xml
5555
<plugin>
56-
<groupId>fvarrui.maven</groupId>
56+
<groupId>io.github.fvarrui</groupId>
5757
<artifactId>javapackager</artifactId>
5858
<version>{latest-plugin-version-here}</version>
5959
<executions>
@@ -77,7 +77,7 @@ Also, JavaPackager plugin is able to get some properties from `pom.xml`, so you
7777

7878
```xml
7979
<plugin>
80-
<groupId>fvarrui.maven</groupId>
80+
<groupId>io.github.fvarrui</groupId>
8181
<artifactId>javapackager</artifactId>
8282
<version>{latest-plugin-version-here}</version>
8383
<executions>
@@ -100,7 +100,7 @@ Also, JavaPackager plugin is able to get some properties from `pom.xml`, so you
100100

101101
```xml
102102
<plugin>
103-
<groupId>fvarrui.maven</groupId>
103+
<groupId>io.github.fvarrui</groupId>
104104
<artifactId>javapackager</artifactId>
105105
<version>{latest-plugin-version-here}</version>
106106
<executions>
@@ -123,8 +123,8 @@ Also, JavaPackager plugin is able to get some properties from `pom.xml`, so you
123123

124124
```xml
125125
<plugin>
126-
<groupId>fvarrui.maven</groupId>
127-
<artifactId>javapackager</artifactId>
126+
<groupId>io.github.fvarrui</groupId>
127+
<artifactId>javapackager</artifactId>
128128
<version>{latest-plugin-version-here}</version>
129129
<executions>
130130
<execution>
@@ -141,4 +141,41 @@ Also, JavaPackager plugin is able to get some properties from `pom.xml`, so you
141141
</execution>
142142
</executions>
143143
</plugin>
144-
```
144+
```
145+
146+
## Multiple executions
147+
148+
```xml
149+
<plugin>
150+
<groupId>io.github.fvarrui</groupId>
151+
<artifactId>javapackager</artifactId>
152+
<version>{latest-plugin-version-here}</version>
153+
<executions>
154+
<execution>
155+
<phase>package</phase>
156+
<goals>
157+
<goal>package</goal>
158+
</goals>
159+
<configuration>
160+
<name>Sample-with-jre</name>
161+
<mainClass>fvarrui.sample.Main</mainClass>
162+
<bundleJre>true</bundleJre>
163+
</configuration>
164+
</execution>
165+
<execution>
166+
<phase>package</phase>
167+
<goals>
168+
<goal>package</goal>
169+
</goals>
170+
<configuration>
171+
<name>Sample-without-jre</name>
172+
<mainClass>fvarrui.sample.Main</mainClass>
173+
<bundleJre>false</bundleJre>
174+
</configuration>
175+
</execution>
176+
</executions>
177+
</plugin>
178+
```
179+
Last configuration, e.g. on Windows, will generate next artifacts:
180+
* `Sample-with-jre_x.y.z.exe` with a bundled JRE.
181+
* `Sample-without-jre_x.y.z.exe` without JRE.

0 commit comments

Comments
 (0)