Skip to content

Commit

Permalink
applied suggests
Browse files Browse the repository at this point in the history
  • Loading branch information
videnkz committed Dec 4, 2023
1 parent 588922b commit 6469734
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ See [`apm-agent-plugins/README.md`](apm-agent-plugins/README.md)
HTML Documentation is generated from text files stored in `docs` folder using [AsciiDoc](http://asciidoc.org/) format.
The `configuration.asciidoc` file is generated from running `co.elastic.apm.agent.configuration.ConfigurationExporter`
(e.g. via `./mvnw -Dsurefire.failIfNoTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test`
or on Windows `./mvnw '-Dsurefire.failIfNoTests=false' '-Dsurefire.failIfNoSpecifiedTests=false' -Dtest=ConfigurationExporterTest -pl apm-agent-builds/apm-agent -am clean test`).
or on Windows `.\mvnw '-Dsurefire.failIfNoTests=false' '-Dsurefire.failIfNoSpecifiedTests=false' -Dtest=ConfigurationExporterTest -pl apm-agent-builds/apm-agent -am clean test`).
All the other asciidoc text files are written manually.

A preview of the documentation is generated for each pull-request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ void testGeneratedConfigurationDocsAreUpToDate() throws IOException, TemplateExc
.withFailMessage("The rendered configuration documentation (/docs/configuration.asciidoc) is not up-to-date.\n" +
"If you see this error on CI, it means you have to execute the tests locally " +
"(./mvnw -Dsurefire.failIfNoTests=false -Dsurefire.failIfNoSpecifiedTests=false -Dtest=ConfigurationExporterTest -pl apm-agent -am clean test) " +
"or on Windows(./mvnw '-Dsurefire.failIfNoTests=false' '-Dsurefire.failIfNoSpecifiedTests=false' -Dtest=ConfigurationExporterTest -pl apm-agent-builds/apm-agent -am clean test) " +
"or on Windows(.\\mvnw '-Dsurefire.failIfNoTests=false' '-Dsurefire.failIfNoSpecifiedTests=false' -Dtest=ConfigurationExporterTest -pl apm-agent-builds/apm-agent -am clean test) " +
"which will update the rendered docs.\n" +
"If you see this error while running the tests locally, there's nothing more to do - the rendered docs have been updated " +
"and the following test execution should not have failed.")
Expand Down

0 comments on commit 6469734

Please sign in to comment.