Skip to content

Commit 73b691f

Browse files
committed
readme build section update
1 parent 559175b commit 73b691f

File tree

1 file changed

+19
-30
lines changed

1 file changed

+19
-30
lines changed

README.md

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,53 +13,42 @@ The application makes use of the employee sample table supplied with Db2 for z/O
1313
* Either Gradle or Apache Maven on the workstation (optional if using Wrappers)
1414

1515
## Building
16-
You can build the sample using an IDE of your choice, or you can build it from the command line. For both approaches, using the supplied Gradle or Maven wrapper is the recommended way to get a consistent version of build tooling.
17-
18-
On the command line, you simply swap the Gradle or Maven command for the wrapper equivalent, `gradlew` or `mvnw` respectively.
16+
You can build the sample using an IDE of your choice, or you can build it from the command line. For both approaches, using the supplied Gradle or Maven wrapper is the will give a consistent version of build tooling.
1917

2018
For an IDE, taking Eclipse as an example, the plug-ins for Gradle *buildship* and Maven *m2e* will integrate with the "Run As..." capability, allowing you to specify whether you want to build the project with a Wrapper, or a specific version of your chosen build tool.
2119

22-
The required build-tasks are typically `clean build` for Gradle and `clean verify` for Maven. Once run, Gradle will generate a JAR file in the `build/libs` directory, while Maven will generate it in the `target` directory.
23-
2420
**Note:** If you import the project to your IDE, you might experience local project compile errors. To resolve these errors you should run a tooling refresh on that project.
2521
For example, in Eclipse:
2622
* for Gradle, right-click on "Project", select "Gradle -> Refresh Gradle Project",
2723
* for Maven, right-click on "Project", select "Maven -> Update Project...".
2824

2925
> Tip: *In Eclipse, Gradle (buildship) is able to fully refresh and resolve the local classpath even if the project was previously updated by Maven. However, Maven (m2e) does not currently reciprocate that capability. If you previously refreshed the project with Gradle, you'll need to manually remove the 'Project Dependencies' entry on the Java build-path of your Project Properties to avoid duplication errors when performing a Maven Project Update.*
3026
31-
#### Gradle Wrapper (command line)
32-
Run the following in a local command prompt:
27+
### Building with Gradle
3328

34-
On Linux or Mac:
29+
A JAR file is created inside the `cics-java-osgi-jdbc-app/build/libs` directory and a CICS bundle ZIP file inside the `cics-java-osgi-jdbc-bundle/build/distributions` directory.
3530

36-
```shell
37-
./gradlew clean build
38-
```
39-
On Windows:
40-
41-
```shell
42-
gradlew.bat clean build
43-
```
31+
If using the CICS bundle ZIP, the CICS JVM server name should be modified in the `cics.jvmserver` property in the gradle build [cics-java-osgi-jdbc-bundle/build.gradle](cics-java-osgi-jdbc-bundle/build.gradle) to match the required CICS JVMSERVER resource name, or alternatively can be set on the command line.
4432

45-
This creates a JAR file in the `build/libs` directory.
33+
| Tool | Command |
34+
| ----------- | ----------- |
35+
| Gradle Wrapper (Linux/Mac) | ```./gradlew clean build``` |
36+
| Gradle Wrapper (Windows) | ```gradle.bat clean build``` |
37+
| Gradle (command-line) | ```gradle clean build``` |
38+
| Gradle (command-line & setting jvmserver) | ```gradle clean build -Pcics.jvmserver=MYJVM``` |
4639

47-
#### Maven Wrapper (command line)
48-
Run the following in a local command prompt:
40+
### Building with Apache Maven
4941

50-
On Linux or Mac:
42+
A JAR file is created inside the `cics-java-osgi-jdbc-app/target` directory and a CICS bundle ZIP file inside the `cics-java-osgi-jdbc-bundle/target` directory.
5143

52-
```shell
53-
./mvnw clean verify
54-
```
55-
56-
On Windows:
57-
58-
```shell
59-
mvnw.cmd clean verify
60-
```
44+
If building a CICS bundle ZIP the CICS bundle plugin bundle-war goal is driven using the maven verify phase. The CICS JVM server name should be modified in the `<cics.jvmserver>` property in the [`pom.xml`](pom.xml) to match the required CICS JVMSERVER resource name, or alternatively can be set on the command line.
6145

62-
This creates a JAR file in the `target` directory.
46+
| Tool | Command |
47+
| ----------- | ----------- |
48+
| Maven Wrapper (Linux/Mac) | ```./mvnw clean verify``` |
49+
| Maven Wrapper (Windows) | ```mvnw.cmd clean verify``` |
50+
| Maven (command-line) | ```mvn clean verify``` |
51+
| Maven (command-line & setting jvmserver) | ```mvn clean verify -Dcics.jvmserver=MYJVM``` |
6352

6453
## Deploying
6554
Configure the JVM profile of the OSGi JVM server to include the Db2 driver JARs in the `OSGI_BUNDLES` environment variable and the Db2 library in the `LIBRARY_SUFFIX` environment variable. For more information, see the provided [JVM profile template](etc/jvmprofiles/DFHOSGI.jvmprofile). If necessary, restart the JVM server.

0 commit comments

Comments
 (0)