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

Use Gradle because to document junit-platform-launcher dependency #2783

Merged
merged 1 commit into from
Nov 20, 2021
Merged

Use Gradle because to document junit-platform-launcher dependency #2783

merged 1 commit into from
Nov 20, 2021

Conversation

aSemy
Copy link
Contributor

@aSemy aSemy commented Nov 20, 2021

Overview

Link to view rendered doc

A really minor change, but I think using 'because' makes the comment more clear - that it's referring to the the junit-platform-launcher dependency.

From the Gradle docs

Documenting Dependencies

When you declare a dependency or a dependency constraint, you can provide a custom reason for the declaration. This makes the dependency declarations in your build script and the dependency insight report easier to interpret.

Before

testImplementation(platform("org.junit:junit-bom:{bom-version}"))
// Only needed to run tests in a version of IntelliJ IDEA that bundles older versions
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
testRuntimeOnly("org.junit.vintage:junit-vintage-engine")

After

testImplementation(platform("org.junit:junit-bom:{bom-version}"))
testRuntimeOnly("org.junit.platform:junit-platform-launcher") {
  because("Only needed to run tests in a version of IntelliJ IDEA that bundles older versions")
}
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
testRuntimeOnly("org.junit.vintage:junit-vintage-engine")

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


Definition of Done

@codecov
Copy link

codecov bot commented Nov 20, 2021

Codecov Report

Merging #2783 (5cb390d) into main (450e94a) will increase coverage by 91.03%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2783       +/-   ##
===========================================
+ Coverage        0   91.03%   +91.03%     
- Complexity      0     4465     +4465     
===========================================
  Files           0      384      +384     
  Lines           0    10810    +10810     
  Branches        0      839      +839     
===========================================
+ Hits            0     9841     +9841     
- Misses          0      746      +746     
- Partials        0      223      +223     
Impacted Files Coverage Δ
...atform/commons/PreconditionViolationException.java 100.00% <0.00%> (ø)
...ain/java/org/junit/jupiter/api/AssertionUtils.java 77.41% <0.00%> (ø)
...launcher/core/LauncherConfigurationParameters.java 90.32% <0.00%> (ø)
...rg/junit/platform/commons/util/ExceptionUtils.java 77.77% <0.00%> (ø)
.../junit/platform/commons/logging/LoggerFactory.java 71.87% <0.00%> (ø)
...iter/engine/execution/DefaultParameterContext.java 88.23% <0.00%> (ø)
...tform/engine/support/descriptor/ResourceUtils.java 100.00% <0.00%> (ø)
...in/java/org/junit/platform/launcher/TagFilter.java 100.00% <0.00%> (ø)
.../launcher/core/EngineDiscoveryErrorDescriptor.java 100.00% <0.00%> (ø)
...jupiter/engine/extension/TimeoutConfiguration.java 100.00% <0.00%> (ø)
... and 374 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 450e94a...5cb390d. Read the comment docs.

@sbrannen sbrannen self-assigned this Nov 20, 2021
@sbrannen sbrannen added this to the 5.9 M1 milestone Nov 20, 2021
@sbrannen sbrannen changed the title Minor documentation improvement: Use Gradle 'because' to document junit-platform-launcher dependency Use Gradle because to document junit-platform-launcher dependency Nov 20, 2021
@sbrannen sbrannen merged commit 6a47ae1 into junit-team:main Nov 20, 2021
@sbrannen
Copy link
Member

This has been merged into main.

Thanks

runningcode pushed a commit to runningcode/junit5 that referenced this pull request Feb 15, 2023
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.

None yet

3 participants