Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit 1b616d3

Browse files
scottkurzscottkurz
authored
Merge pull request #398 from ajm01/readmeUpdate
doc updates
2 parents 34c24b9 + 28455db commit 1b616d3

File tree

2 files changed

+145
-27
lines changed

2 files changed

+145
-27
lines changed

‎README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,17 @@ There are two, separate active Boost projects.
1212

1313
with a Boost Gradle project under development.
1414

15-
### Developing Boost
15+
### Using the Boost Maven Plugin
16+
Please see the [boost-maven plugin documentation](https://github.com/MicroShed/boost/tree/master/boost-maven#boost-maven-plugin-prototype) for details on using boost in your maven application project.
17+
18+
To see an example of Boost in use in a maven application project, please see our sample application project [here](https://github.com/OpenLiberty/boosted-microprofile-rest-client)
1619

17-
If you are interested in contributing to Boost, read the [wiki](https://github.com/dev-tools-for-enterprise-java/boost/wiki) for more information.
20+
### Developing Boost
1821

19-
If you are interested in the Boost runtime adapter mechanism, it is described in greater detail in the [Boost Runtimes](https://github.com/dev-tools-for-enterprise-java/boost/wiki/Boost-Runtimes) page of the wiki.
22+
If you are interested in contributing to Boost, read the [wiki](https://github.com/MicroShed/boost/wiki) for more information.
2023

24+
If you are interested in the Boost runtime adapter SPI, it is described in greater detail in the [Boost Runtimes Adapter SPI](https://github.com/MicroShed/boost/wiki/Boost-Runtime-Adapter-SPI) page of the wiki.
25+
git
2126
### Building Boost
2227

2328
You will need to build the `boost-common` project before building the `boost-maven` project. We provide some scripts below to simplify this process.

‎boost-maven/README.md‎

Lines changed: 137 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Boost Maven Plugin Prototype
22

3-
### What is Boost?
3+
### What is the Boost Maven Plugin?
44

55
This is a prototype Maven plugin to package a fully configured Java EE or MicroProfile application with a target runtime.
66

@@ -11,35 +11,148 @@ When added to your pom.xml, the plugin will
1111
3. Install the application to the server.
1212
4. Configure the server appropriately for the application.
1313

14-
### Build the Boost Maven Plugin
14+
### Using the Boost Maven Plugin
1515

16-
1. `git clone git@github.com:OpenLiberty/boost.git`
17-
2. `boost-maven.sh`
16+
Boost is an end-to-end packaging and dependency management plugin for Jakarta EE and Microprofile applications. To use Boost in your project, define the plugin and add the appropriate BOM and Booster dependencies to manage various MicroProfile features.
1817

19-
### Use the Boost Maven Plugin
18+
## Defining the plugin
2019

21-
Edit your project pom.xml and place the following plugin stanza into your build:
20+
Add the following to the `<plugins>` section of your project's pom.xml:
2221
```xml
23-
<plugin>
24-
<groupId>org.microshed.boost</groupId>
25-
<artifactId>boost-maven-plugin</artifactId>
26-
<version>0.2.2-SNAPSHOT</version>
27-
<executions>
28-
<execution>
29-
<goals>
30-
<goal>package</goal>
31-
</goals>
32-
</execution>
33-
</executions>
34-
</plugin>
35-
```
22+
<plugin>
23+
<groupId>org.microshed.boost</groupId>
24+
<artifactId>boost-maven-plugin</artifactId>
25+
<version>0.2.1</version>
26+
<executions>
27+
<execution>
28+
<phase>package</phase>
29+
<goals>
30+
<goal>package</goal>
31+
</goals>
32+
</execution>
33+
</executions>
34+
</plugin>
35+
```
36+
## Execution goals
3637

37-
Run `mvn clean package`
38+
* Package - packages your project into an executable jar file
3839

39-
### Tutorial
40+
## Boost BOMs
4041

41-
For more detailed instructions on using the boost plugin, see [here](https://github.com/OpenLiberty/boost/wiki/Boosted-MicroProfile-Rest-Client-sample-app).
42+
The Boost BOMs define which version of Jakarta EE or MicroProfile is required. This will influence which features are loaded as compile and runtime dependencies.
4243

43-
### Building and Developing Boost
44+
### EE7-BOM
4445

45-
See [here](https://github.com/OpenLiberty/boost/wiki/Home)
46+
Defining the EE7 BOM ensures that all EE features comply with the EE7 specification.
47+
48+
```xml
49+
<dependencyManagement>
50+
<dependencies>
51+
<dependency>
52+
<groupId>org.microshed.boost.boosters</groupId>
53+
<artifactId>ee7-bom</artifactId>
54+
<version>0.2.1</version>
55+
<scope>import</scope>
56+
<type>pom</type>
57+
</dependency>
58+
</dependencies>
59+
</dependencyManagement>
60+
```
61+
62+
### EE8-BOM
63+
64+
Defining the EE8 BOM ensures that all EE features comply with the EE8 specification.
65+
66+
```xml
67+
<dependencyManagement>
68+
<dependencies>
69+
<dependency>
70+
<groupId>org.microshed.boost.boosters</groupId>
71+
<artifactId>ee8-bom</artifactId>
72+
<version>0.2.1</version>
73+
<scope>import</scope>
74+
<type>pom</type>
75+
</dependency>
76+
</dependencies>
77+
</dependencyManagement>
78+
```
79+
80+
### MP20-BOM
81+
82+
Defining the MP20 BOM ensures that all MicroProfile features comply with the 2.0 specification.
83+
84+
```xml
85+
<dependencyManagement>
86+
<dependencies>
87+
<dependency>
88+
<groupId>org.microshed.boost.boosters</groupId>
89+
<artifactId>mp20-bom</artifactId>
90+
<version>0.2.1</version>
91+
<scope>import</scope>
92+
<type>pom</type>
93+
</dependency>
94+
</dependencies>
95+
</dependencyManagement>
96+
```
97+
### MP21-BOM
98+
99+
Defining the MP21 BOM ensures that all MicroProfile features comply with the 2.1 specification.
100+
101+
```xml
102+
<dependencyManagement>
103+
<dependencies>
104+
<dependency>
105+
<groupId>org.microshed.boost.boosters</groupId>
106+
<artifactId>mp21-bom</artifactId>
107+
<version>0.2.1</version>
108+
<scope>import</scope>
109+
<type>pom</type>
110+
</dependency>
111+
</dependencies>
112+
</dependencyManagement>
113+
```
114+
### MP22-BOM
115+
116+
Defining the MP22 BOM ensures that all MicroProfile features comply with the 2.2 specification.
117+
118+
```xml
119+
<dependencyManagement>
120+
<dependencies>
121+
<dependency>
122+
<groupId>org.microshed.boost.boosters</groupId>
123+
<artifactId>mp22-bom</artifactId>
124+
<version>0.2.1</version>
125+
<scope>import</scope>
126+
<type>pom</type>
127+
</dependency>
128+
</dependencies>
129+
</dependencyManagement>
130+
```
131+
### MP30-BOM
132+
133+
Defining the MP30 BOM ensures that all MicroProfile features comply with the 3.0 specification.
134+
135+
```xml
136+
<dependencyManagement>
137+
<dependencies>
138+
<dependency>
139+
<groupId>org.microshed.boost.boosters</groupId>
140+
<artifactId>mp30-bom</artifactId>
141+
<version>0.2.1</version>
142+
<scope>import</scope>
143+
<type>pom</type>
144+
</dependency>
145+
</dependencies>
146+
</dependencyManagement>
147+
```
148+
149+
## Boosters
150+
151+
Boost provides a set of dependencies called boosters for various Jakarta EE and MicroProfile features. These Boosters will automatically pull in the appropriate compile and runtime dependencies needed for that feature. Depending on which BOM is defined, Boost will choose the appropriate versions for each feature.
152+
153+
For a full list of supported boosters and their usage, see [here](https://github.com/MicroShed/boost/wiki/Boosters).
154+
155+
## Build Your Boosted Application Project
156+
Once your application project pom.xml is finalized with the Boost Plugin, Boost BOMs and booster dependencies, issue the following Maven command:
157+
158+
`mvn clean package`

0 commit comments

Comments
 (0)