Skip to content

Commit fb7e8b0

Browse files
Standardize README and build commands per validation framework
- Add License badge to header - Add Key Features section with bullet points - Add Table of Contents with all mandatory sections - Fix Maven build commands: package → verify (lines 127, 132, 156) - Fix GitHub Actions: Maven package → verify, add clean to Gradle commands - Update deployment section title to 'Deploying to a CICS Liberty JVM server' - Standardize deployment method names and order per template - Update Method 2 name: 'CICS Explorer Deployment' → 'CICS Explorer SDK Deployment' - Fix terminology: 'CICS bundle project' → 'CICS Bundle Project' - Add Additional Resources section with relevant links - Add Contributing section with guidelines link All changes align with Agents.md validation rules and README-TEMPLATE-SpringBoot.md
1 parent c548c44 commit fb7e8b0

2 files changed

Lines changed: 46 additions & 13 deletions

File tree

.github/workflows/build.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
distribution: "semeru"
4444
cache: maven
4545
- name: Build with Maven
46-
run: mvn --batch-mode --update-snapshots --file pom.xml -Djava.version=${{ matrix.jdk }} package
46+
run: mvn --batch-mode --update-snapshots --file pom.xml -Djava.version=${{ matrix.jdk }} verify
4747

4848
build-mvnw:
4949
name: Build Maven Wrapper
@@ -61,7 +61,7 @@ jobs:
6161
distribution: "semeru"
6262
cache: maven
6363
- name: Build with Maven Wrapper
64-
run: ./mvnw --batch-mode --update-snapshots --file pom.xml -Djava.version=${{ matrix.jdk }} package
64+
run: ./mvnw --batch-mode --update-snapshots --file pom.xml -Djava.version=${{ matrix.jdk }} verify
6565

6666
build-gradle:
6767
name: Build Gradle
@@ -82,7 +82,7 @@ jobs:
8282
with:
8383
gradle-version: 8.14.4
8484
- name: Build with Gradle
85-
run: gradle build -Pjava_version=${{ matrix.jdk }}
85+
run: gradle clean build -Pjava_version=${{ matrix.jdk }}
8686

8787
build-gradlew:
8888
name: Build Gradle Wrapper
@@ -99,6 +99,6 @@ jobs:
9999
java-version: ${{ matrix.jdk }}
100100
distribution: 'semeru'
101101
- name: Build with Gradle Wrapper
102-
run: ./gradlew build -Pjava_version=${{ matrix.jdk }}
102+
run: ./gradlew clean build -Pjava_version=${{ matrix.jdk }}
103103

104104
# Made with Bob

README.md

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,32 @@
11
# cics-java-liberty-springboot-jcics
22
[![Build](https://github.com/cicsdev/cics-java-liberty-springboot-jcics/actions/workflows/build.yaml/badge.svg)](https://github.com/cicsdev/cics-java-liberty-springboot-jcics/actions/workflows/build.yaml)
3+
[![License](https://img.shields.io/badge/License-EPL%202.0-red.svg)](https://www.eclipse.org/legal/epl-2.0/)
34

45
## Overview
56

67
This sample provides a Spring Boot application that uses the JCICS TSQ Java API to provide a RESTful CICS temporary storage queue (TSQ) browsing service. The sample demonstrates how to integrate Spring Boot with IBM CICS using the JCICS API on a CICS Liberty JVM server.
78

9+
## Key Features
10+
11+
- **JCICS API Integration**: Direct use of CICS Java APIs for TSQ operations
12+
- **RESTful Services**: Spring Boot REST endpoints for TSQ management
13+
- **Multi-Module Project**: Separate application and CICS bundle modules
14+
- **Multi-Build Support**: Compatible with both Gradle and Maven
15+
- **CICS Bundle Deployment**: Automated deployment using CICS bundle plugins
16+
17+
## Table of Contents
18+
19+
- [Overview](#overview)
20+
- [Key Features](#key-features)
21+
- [Requirements](#requirements)
22+
- [Downloading](#downloading)
23+
- [Building the Sample](#building-the-sample)
24+
- [Deploying to a CICS Liberty JVM server](#deploying-to-a-cics-liberty-jvm-server)
25+
- [Running the Sample](#running-the-sample)
26+
- [License](#license)
27+
- [Additional Resources](#additional-resources)
28+
- [Contributing](#contributing)
29+
830
The sample is structured as a multi-module project with:
931
- **cics-java-liberty-springboot-jcics-app** - The Spring Boot application module
1032
- **cics-java-liberty-springboot-jcics-cicsbundle** - The CICS bundle module for deployment
@@ -102,12 +124,12 @@ gradlew.bat clean build
102124

103125
Linux/Mac:
104126
```bash
105-
./mvnw clean package
127+
./mvnw clean verify
106128
```
107129

108130
Windows:
109131
```cmd
110-
mvnw.cmd clean package
132+
mvnw.cmd clean verify
111133
```
112134

113135
**Output:**
@@ -131,7 +153,7 @@ mvnw.cmd clean package
131153

132154
3. **Build the Project:**
133155
- Right-click on root project → Run As → Gradle Build (or Maven Build)
134-
- Goals: `clean build` (Gradle) or `clean package` (Maven)
156+
- Goals: `clean build` (Gradle) or `clean verify` (Maven)
135157

136158
**Notes:**
137159
- When building a WAR file for deployment to Liberty it is good practice to exclude Tomcat from the final runtime artifact. We demonstrate this in the pom.xml with the *provided* scope, and in build.gradle with the *providedRuntime()* dependency.
@@ -143,7 +165,7 @@ mvnw.cmd clean package
143165

144166

145167

146-
## Deploying to CICS
168+
## Deploying to a CICS Liberty JVM server
147169

148170
### Prerequisites
149171

@@ -153,7 +175,7 @@ Ensure you have the following features defined in your Liberty `server.xml`:
153175

154176
---
155177

156-
### Method 1: CICS Bundle Deployment (Gradle/Maven)
178+
### Method 1: CICS Bundle Plugin Deployment (Gradle/Maven)
157179

158180
This is the **recommended** deployment method as it uses the CICS bundle generated during the build process.
159181

@@ -191,11 +213,11 @@ cics.jvmserver = 'YOUR_JVMSERVER_NAME' // e.g., 'DFHWLP'
191213

192214
---
193215

194-
### Method 2: CICS Explorer Deployment
216+
### Method 2: CICS Explorer SDK Deployment
195217

196-
1. Copy the built WAR from your *target* or *build/libs* directory into an Eclipse CICS bundle project
218+
1. Copy the built WAR from your *target* or *build/libs* directory into an Eclipse CICS Bundle Project
197219
2. Create a new WAR bundlepart that references the WAR file
198-
3. Deploy the CICS bundle project from CICS Explorer using the **Export Bundle Project to z/OS UNIX File System** wizard
220+
3. Deploy the CICS Bundle Project from CICS Explorer using the **Export Bundle Project to z/OS UNIX File System** wizard
199221

200222
---
201223

@@ -271,4 +293,15 @@ The example application is divided into four services which perform actions on a
271293
272294
273295
## License
274-
This project is licensed under [Eclipse Public License - v 2.0](LICENSE).
296+
This project is licensed under [Eclipse Public License - v 2.0](LICENSE).
297+
298+
## Additional Resources
299+
300+
- [CICS TS for z/OS Documentation](https://www.ibm.com/docs/en/cics-ts)
301+
- [Spring Boot Java applications for CICS, Part 1: JCICS, Gradle, and Maven](https://developer.ibm.com/tutorials/spring-boot-java-applications-for-cics-part-1-jcics-maven-gradle/)
302+
- [CICS Java Development](https://www.ibm.com/docs/en/cics-ts/latest?topic=programming-java-applications)
303+
- [Spring Boot Documentation](https://spring.io/projects/spring-boot)
304+
305+
## Contributing
306+
307+
Contributions are welcome! Please read our [contributing guidelines](https://github.com/cicsdev/.github/blob/main/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.

0 commit comments

Comments
 (0)