Skip to content

javadoc: clarify statelessTestsetReporter, consoleOutputReporter, - #3410

Merged
olamy merged 1 commit into
apache:masterfrom
joshinii:master
Jul 31, 2026
Merged

olamy merged 1 commit into
apache:masterfrom
joshinii:master

Conversation

@joshinii

Copy link
Copy Markdown
Contributor

Adds Javadoc to the three undocumented @parameter fields in
AbstractSurefireMojo, describing what each reporter controls and
linking to the JUnit 5 Platform example page for the full list of
nested configuration elements.

Closes #3386

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Each commit in the pull request should have a meaningful subject line and body.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean install to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean install).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@olamy olamy added the documentation Improvements or additions to documentation label Jul 31, 2026
@olamy olamy self-assigned this Jul 31, 2026
@olamy olamy added this to the 3.6.0-M2 milestone Jul 31, 2026
@olamy
olamy requested a review from Copilot July 31, 2026 03:59

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the usability of the Surefire plugin configuration by adding missing Javadoc for three @Parameter extension/reporter fields in AbstractSurefireMojo, clarifying what each reporter controls and pointing users to the JUnit Platform example page for the full nested configuration options.

Changes:

  • Documented statelessTestsetReporter as the configuration entry point for XML TEST-*.xml reporting, including precedence notes for the deprecated disableXmlReport.
  • Documented consoleOutputReporter for captured stdout/stderr handling, including redirectTestOutputToFile, disable, and encoding.
  • Documented statelessTestsetInfoReporter as the configuration for the per-testset console/text summary reporter.

@olamy
olamy merged commit bbbb8c0 into apache:master Jul 31, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify Javadoc of plugin parameters "consoleOutputReporter", "statelessTestsetInfoReporter" and "statelessTestsetReporter"

3 participants