Add documentation, config template and ownership files - #8
Conversation
Manvi-55
commented
Aug 25, 2026
Manvi-55
commented
- Rewrite README.md: build+licence badges, Overview with Key Features, standard sections (Prerequisites, Downloading, Check dependencies, Building the Sample, Deploying to CICS Liberty JVM server with 3 deployment methods, Running, Troubleshooting, License, Contributing)
- Update build commands: clean build (Gradle), clean verify (Maven)
- Update prerequisites: CICS TS V6.1+, Java 17+, Jakarta EE 10
- Add CODEOWNERS replacing MAINTAINERS.md (Issue: old convention)
- Add etc/config/liberty/server.xml sample config with servlet-6.0, jdbc-4.3, transaction-1.2, T2 and T4 dataSource definitions
- Add .github/workflows/cleanup-old-runs.yaml (weekly, 30 day retention)
- Rewrite README.md: build+licence badges, Overview with Key Features, standard sections (Prerequisites, Downloading, Check dependencies, Building the Sample, Deploying to CICS Liberty JVM server with 3 deployment methods, Running, Troubleshooting, License, Contributing) - Update build commands: clean build (Gradle), clean verify (Maven) - Update prerequisites: CICS TS V6.1+, Java 17+, Jakarta EE 10 - Add CODEOWNERS replacing MAINTAINERS.md (Issue: old convention) - Add etc/config/liberty/server.xml sample config with servlet-6.0, jdbc-4.3, transaction-1.2, T2 and T4 dataSource definitions - Add .github/workflows/cleanup-old-runs.yaml (weekly, 30 day retention)
IvanHargreaves
left a comment
IvanHargreaves
left a comment
There was a problem hiding this comment.
Just a couple of points to address, thanks.
| password="YOUR_PASSWORD"/> | ||
| </dataSource> | ||
|
|
||
| <!-- Default HTTP End Point --> |
There was a problem hiding this comment.
I think the content of server.xml is actually too comprehensive compared to other samples. The intent is to show only the parts that are required by the sample, rather than all the current best-practice that we have in the template server.xml shipped with CICS.
The extra security headers and strict-transport configurations are not always wanted in development/samples, so I perhaps use other Spring Boot samples as a guide to the content here instead, thanks.
| @@ -1,3 +1,6 @@ | |||
| # Office temporary lock files (e.g. ~$server.xml created by Word/Excel) | |||
There was a problem hiding this comment.
I don't recall seeing this before in any of the gitignore files in our samples? I might be wrong, but if the others don't contain it, maybe it's too detailed to include this, many of our user don't even use Microsoft tools, so it might be excessive to include this - but compare against other samples as I might be misremembering, thanks.
There was a problem hiding this comment.
yeah,reverted back,thanks!
- gradle-wrapper.properties: remove networkTimeout and validateDistributionUrl (Agents.md: standard is exactly 5 lines; these settings use Gradle defaults) - etc/config/liberty/server.xml: db2v12 -> db2v13 (V12 out of support), remove unrelated JMS/MQ resources (wasJmsEndpoint, jmsConnectionFactory, connectionManager, MQ variable comment) not applicable to a JDBC sample, remove cicsts:core-1.0 and cicsts:security-1.0 from featureManager (auto-injected by CICS integrated mode — do not ask users to add) - README.md: align featureManager snippet with server.xml template (remove transaction-1.2/cicsts:core/security, add transportSecurity-1.0, add note that cicsts:core-1.0 is auto-injected), update Db2 prerequisite from V12 to V13 or later - .gitignore: add ~$* pattern to exclude Office lock files (e.g. ~$server.xml)
ef46cd3 to
773d118
Compare
2 participants
