Skip to content

Conversation

NikhilGupta-Dev
Copy link

Added a documentation section referencing the official JUnit 5 + Bazel starter project.

This PR adds Bazel build support documentation to the running-tests.adoc file. The new section provides users with information about Bazel's support for running tests on the JUnit Platform and includes a reference to the official JUnit 5 + Bazel Starter Sample project.

Related to documentation improvement efforts for better build tool coverage.


I hereby agree to the terms of the JUnit Contributor License Agreement.

Definition of Done


I hereby agree to the terms of the JUnit Contributor License Agreement.


Definition of Done

@sbrannen sbrannen changed the title Docs: Add Bazel build support referenceDocs: Add Bazel build support referenceDocs: Add Bazel build support reference.Docs: Add Bazel build support… Document Bazel build support in the User Guide Aug 28, 2025
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 @NikhilGupta-Dev,

I'm not sure if this is a "work in progress", but you deleted large sections of the documentation.

Please undo that and submit only changes that introduce documentation for Bazel.

Thanks

@sbrannen sbrannen marked this pull request as draft August 28, 2025 13:25
@NikhilGupta-Dev
Copy link
Author

Hi @sbrannen, I have restored the original documentation and added the Bazel section exactly as requested. No other content was changed. Thank you for your guidance—please let me know if there is anything further needed.

@NikhilGupta-Dev NikhilGupta-Dev marked this pull request as ready for review August 28, 2025 14:38
@sormuras
Copy link
Member

Ho @NikhilGupta-Dev

did you create the modified User-Guide on your machine and verified the existing hierarchy didn't change?

I think, they are off by more then one.

Are you sure you want to add the Bazel-related texts into an IDE-related section?

No. Please move them to https://docs.junit.org/current/user-guide/#running-tests-build - right next after the Ant section.

Also, please revert the deletion of empty lines your commit shows here: https://github.com/junit-team/junit-framework/pull/4883/files

In addition to that, it suffices to write "JUnit" instead of "JUnit 5" - as number 6 is just around the corner.

@sormuras sormuras marked this pull request as draft August 28, 2025 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants