Skip to content

Document how to use Docker Compose integration when running tests#36636

Closed
OnSuorce wants to merge 2 commits intospring-projects:mainfrom
OnSuorce:docker-compose-for-test
Closed

Document how to use Docker Compose integration when running tests#36636
OnSuorce wants to merge 2 commits intospring-projects:mainfrom
OnSuorce:docker-compose-for-test

Conversation

@OnSuorce
Copy link
Contributor

@OnSuorce OnSuorce commented Jul 28, 2023

Added note to indicate how to enable spring-boot-docker-compose module in @SpringBootTest tests

Added note to indicate how to enable support for spring docker compose module in @SpringBootTest tests
@pivotal-cla
Copy link

@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.

@pivotal-cla
Copy link

@OnSuorce Thank you for signing the Contributor License Agreement!

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jul 28, 2023
@OnSuorce
Copy link
Contributor Author

Hi,
Did i write the pull request message wrongly? It seems to me that the issue #35661 was not recognized.

@wilkinsona wilkinsona changed the title Update docker-compose doc with test support #35661 Document how to use Docker Compose integration when running tests Jul 28, 2023
@wilkinsona wilkinsona added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Jul 28, 2023
@wilkinsona wilkinsona added this to the 3.1.x milestone Jul 28, 2023
@wilkinsona
Copy link
Member

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.


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`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@OnSuorce
Copy link
Contributor Author

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.

Ok, next time i'll reference it from the description

@wilkinsona
Copy link
Member

@OnSuorce thank you very much for making your first contribution to Spring Boot.

@OnSuorce
Copy link
Contributor Author

@wilkinsona Thank you for your help. Looking forward to contributing again

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation A documentation update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants