Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to spring.factories used in the TestContext framework in the reference manual #31723

Closed
wants to merge 1 commit into from

Conversation

perlun
Copy link
Contributor

@perlun perlun commented Nov 30, 2023

This type of change would be useful (since it makes it easier for the reader to find this file), but... will it be hard to support with different versions of the docs? Given that it should technically refer to the "same version" of the file (replacing main in the URL with the tag in question), to be really great.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Nov 30, 2023
@sbrannen sbrannen self-assigned this Nov 30, 2023
@sbrannen sbrannen added in: test Issues in the test module type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Nov 30, 2023
@sbrannen sbrannen added this to the 6.1.2 milestone Nov 30, 2023
Copy link
Member

@snicoll snicoll left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I've added a comment for your consideration.

can contribute their own `TestExecutionListener` implementations to the list of default
listeners in the same manner through their own `META-INF/spring.factories` properties
file.
[its `META-INF/spring.factories` properties file](https://github.com/spring-projects/spring-framework/blob/main/spring-test/src/main/resources/META-INF/spring.factories).
Copy link
Member

Choose a reason for hiding this comment

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

This has a spring-framework-code attribute that should be used rather than the hardcoded link. See antora.yml.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for your feedback @snicoll, makes sense. 👍 Nice to learn about some of the Asciidoc features, seems like a nice usage of it in this case.

I adjusted both this and incorporated the suggestion from @sbrannen, please re-check. (Sam - it did perhaps not make as much sense in the https://docs.spring.io/spring-framework/reference/testing/testcontext-framework/ctx-management/context-customizers.html#testcontext-context-customizers-automatic-discovery case, since it referred to both "Spring Framework and Spring Boot", but the link only refers to the Spring Framework one.. but, possibly still a step in the right direction. 🤔)

Copy link
Member

Choose a reason for hiding this comment

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

Yes, indeed. That's a step in the right direction. I'll rework the wording locally after merging the PR.

@sbrannen sbrannen changed the title tel-config: add link to spring.factories Link to spring.factories for default TestExecutionListener config in the reference manual Dec 1, 2023
Copy link
Member

@sbrannen sbrannen left a comment

Choose a reason for hiding this comment

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

Hi @perlun,

In addition to the spring-framework-code change that @snicoll requested, would you be willing to make a similar change to the section on ContextCustomizerFactory configuration?

If not, we can handle that ourselves.

In any case, please let us know so that we can proceed with this PR.

@sbrannen sbrannen added the status: waiting-for-feedback We need additional information before we can continue label Dec 1, 2023
@sbrannen sbrannen removed the status: waiting-for-feedback We need additional information before we can continue label Dec 4, 2023
@sbrannen sbrannen changed the title Link to spring.factories for default TestExecutionListener config in the reference manual Link to spring.factories for the TestContext framework in the reference manual Dec 4, 2023
@sbrannen sbrannen changed the title Link to spring.factories for the TestContext framework in the reference manual Link to spring.factories used in the TestContext framework in the reference manual Dec 4, 2023
sbrannen added a commit to sbrannen/spring-framework that referenced this pull request Dec 4, 2023
@sbrannen sbrannen closed this in 87d37a2 Dec 4, 2023
@sbrannen
Copy link
Member

sbrannen commented Dec 4, 2023

This has been merged into main in 87d37a2 and revised in 8ed04b5.

Thanks

@perlun perlun deleted the patch-1 branch December 5, 2023 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: test Issues in the test module type: documentation A documentation task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants