Skip to content

Commit a0ac612

Browse files
Copilotchrjohn
andauthored
docs: replace mvn with ./mvnw in golden README files
Agent-Logs-Url: https://github.com/quickfix-j/quickfixj/sessions/377ab540-c500-4f50-b6e2-81bf1af6675e Co-authored-by: chrjohn <6644028+chrjohn@users.noreply.github.com>
1 parent 2eee644 commit a0ac612

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

  • quickfixj-codegenerator/src/test/resources/golden
  • quickfixj-messages/quickfixj-messages-fixlatest/src/test/resources/golden

quickfixj-codegenerator/src/test/resources/golden/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ with the corresponding file here. Missing or extra files also fail the test.
2323
1. Make your generator changes.
2424
2. Rebuild the module to pick up the new code:
2525
```bash
26-
mvn package -pl quickfixj-codegenerator -DskipTests
26+
./mvnw package -pl quickfixj-codegenerator -DskipTests
2727
```
2828
3. Regenerate the golden files by running the generator against both dictionaries
2929
from the `quickfixj-codegenerator` directory:
3030
```bash
3131
# FIX42
32-
java -cp "target/quickfixj-codegenerator-*-SNAPSHOT.jar:$(mvn -q dependency:build-classpath -DincludeScope=compile -Dmdep.outputFile=/dev/stdout)" \
32+
java -cp "target/quickfixj-codegenerator-*-SNAPSHOT.jar:$(./mvnw -q dependency:build-classpath -DincludeScope=compile -Dmdep.outputFile=/dev/stdout)" \
3333
org.quickfixj.codegenerator.MessageCodeGenerator \
3434
--spec ../quickfixj-messages/quickfixj-messages-fix42/src/main/resources/FIX42.xml \
3535
--transform src/main/resources/org/quickfixj/codegenerator \
@@ -45,7 +45,7 @@ with the corresponding file here. Missing or extra files also fail the test.
4545
Alternatively, run the following Maven snippet from the repo root, which uses
4646
the same settings as the test:
4747
```bash
48-
mvn test -pl quickfixj-codegenerator -Dtest=GenerateGoldenFilesManual
48+
./mvnw test -pl quickfixj-codegenerator -Dtest=GenerateGoldenFilesManual
4949
```
5050
*(Create a one-off test class that calls the generator and copies output to
5151
`src/test/resources/golden/` if you prefer a scripted approach.)*
@@ -56,7 +56,7 @@ with the corresponding file here. Missing or extra files also fail the test.
5656
```
5757
5. Run the full test suite to confirm the updated golden files now match:
5858
```bash
59-
mvn test -pl quickfixj-codegenerator
59+
./mvnw test -pl quickfixj-codegenerator
6060
```
6161
6. Commit the updated golden files **together with your generator changes** in the
6262
same commit (or PR) so reviewers can see the diff side-by-side.

quickfixj-messages/quickfixj-messages-fixlatest/src/test/resources/golden/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ with the corresponding file here. Missing or extra files also fail the test.
2929
2. Rebuild `quickfixj-messages-all` to regenerate the minimised XML fixture (if
3030
the XSL or orchestra version changed) and to pick up any updated generator:
3131
```bash
32-
mvn package -pl quickfixj-orchestration,quickfixj-messages/quickfixj-messages-all -DskipTests
32+
./mvnw package -pl quickfixj-orchestration,quickfixj-messages/quickfixj-messages-all -DskipTests
3333
```
3434
3. Regenerate the golden files. The simplest approach is to temporarily point the
3535
test's temporary folder to a fixed path so you can inspect or copy the output.
3636
Alternatively, run the `CodeGeneratorJ` directly:
3737
```bash
3838
# From the repo root – adjust the JAR path to match the current snapshot version
3939
java -cp "quickfixj-orchestration/target/quickfixj-orchestration-*-SNAPSHOT.jar:\
40-
$(mvn -q dependency:build-classpath \
40+
$(./mvnw -q dependency:build-classpath \
4141
-pl quickfixj-messages/quickfixj-messages-fixlatest \
4242
-DincludeScope=test \
4343
-Dmdep.outputFile=/dev/stdout)" \
@@ -62,7 +62,7 @@ with the corresponding file here. Missing or extra files also fail the test.
6262
```
6363
6. Run the test suite to confirm the updated golden files now match:
6464
```bash
65-
mvn test -pl quickfixj-messages/quickfixj-messages-fixlatest
65+
./mvnw test -pl quickfixj-messages/quickfixj-messages-fixlatest
6666
```
6767
7. Commit the updated golden files (and updated fixture if applicable) **together
6868
with your generator/XSL changes** in the same commit (or PR) so reviewers can

0 commit comments

Comments
 (0)