Skip to content

Commit 08bc842

Browse files
authored
updated message that helps run properly ConfigurationExporterTest on windows (#3449)
1 parent eb349d3 commit 08bc842

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,8 +265,9 @@ See [`apm-agent-plugins/README.md`](apm-agent-plugins/README.md)
265265

266266
HTML Documentation is generated from text files stored in `docs` folder using [AsciiDoc](http://asciidoc.org/) format.
267267
The `configuration.asciidoc` file is generated from running `co.elastic.apm.agent.configuration.ConfigurationExporter`
268-
(e.g. via `./mvnw -Dsurefire.failIfNoTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test`). All the other asciidoc text files
269-
are written manually.
268+
(e.g. via `./mvnw -Dsurefire.failIfNoTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test`
269+
or on Windows `.\mvnw "-Dsurefire.failIfNoTests=false" "-Dsurefire.failIfNoSpecifiedTests=false" -Dtest=ConfigurationExporterTest -pl apm-agent-builds/apm-agent -am clean test`).
270+
All the other asciidoc text files are written manually.
270271

271272
A preview of the documentation is generated for each pull-request.
272273
Click on the build `Details` of the `elasticsearch-ci/docs` job and go to the bottom of the `Console Output` to see the link.

apm-agent-builds/apm-agent/src/test/java/co/elastic/apm/agent/configuration/ConfigurationExporterTest.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ void testGeneratedConfigurationDocsAreUpToDate() throws IOException, TemplateExc
120120
assertThat(renderedDocumentation)
121121
.withFailMessage("The rendered configuration documentation (/docs/configuration.asciidoc) is not up-to-date.\n" +
122122
"If you see this error on CI, it means you have to execute the tests locally " +
123-
"(./mvnw -Dsurefire.failIfNoTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test) " +
123+
"(./mvnw -Dsurefire.failIfNoTests=false -Dsurefire.failIfNoSpecifiedTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test) " +
124+
"or on Windows(.\\mvnw \"-Dsurefire.failIfNoTests=false\" \"-Dsurefire.failIfNoSpecifiedTests=false\" -Dtest=ConfigurationExporterTest -pl apm-agent-builds/apm-agent -am clean test) " +
124125
"which will update the rendered docs.\n" +
125126
"If you see this error while running the tests locally, there's nothing more to do - the rendered docs have been updated " +
126127
"and the following test execution should not have failed.")

0 commit comments

Comments
 (0)