Document how to use Docker Compose integration when running tests #36636
Conversation
Added note to indicate how to enable support for spring docker compose module in @SpringBootTest tests
|
@OnSuorce Please sign the Contributor License Agreement! Click here to manually synchronize the status of this Pull Request. See the FAQ for frequently asked questions. |
|
@OnSuorce Thank you for signing the Contributor License Agreement! |
spring-projects-issues
added
the
status: waiting-for-triage
|
Hi, |
wilkinsona
changed the title
wilkinsona
added
type: documentation
|
No, everything's fine. I don't think GitHub lets you reference an issue from the title of an issue or PR, that's all. Thanks for the PR. |
| @@ -37,6 +37,7 @@ When this module is included as a dependency Spring Boot will do the following: | |||
|
|
|||
| NOTE: The `docker compose` or `docker-compose` CLI application needs to be on your path in order for Spring Boot’s support to work correctly. | |||
|
|
|||
| NOTE: If you wish to run docker compose via `spring-boot-docker-compose` when using `@SpringBootTest` 's tests, the property `spring.docker.compose.skip.in-tests` must be set to `false` | |||
There was a problem hiding this comment.
Can you please replace `spring.docker.compose.skip.in-tests` with configprop:spring.docker.compose.skip.in-tests[]. configprop is a macro that runs as part of building the documentation. It verifies that the configuration property exists, helping to ensure the accuracy of the documentation.
Ok, next time i'll reference it from the description |
|
@OnSuorce thank you very much for making your first contribution to Spring Boot. |
|
@wilkinsona Thank you for your help. Looking forward to contributing again |
Added note to indicate how to enable
spring-boot-docker-composemodule in@SpringBootTesttests