Skip to content

Commit

Permalink
docs(gradle): Add descriptions to tasks so they show up without --all
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth committed Aug 15, 2024
1 parent f261664 commit fe5a27f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ tasks.named<DependencyUpdatesTask>("dependencyUpdates") {
// all dependencies at once is beneficial, e.g. for debugging version conflict resolution.
// [1]: https://docs.gradle.org/current/userguide/viewing_debugging_dependencies.html#sec:listing_dependencies
tasks.register("allDependencies") {
group = "Help"
description = "Displays all dependencies declared in all projects."

val dependenciesTasks = getTasksByName("dependencies", /* recursive = */ true).sorted()
dependsOn(dependenciesTasks)

Expand Down
3 changes: 3 additions & 0 deletions buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@ tasks.withType<Detekt>().configureEach detekt@{
}

tasks.register("detektAll") {
group = "Verification"
description = "Run all detekt tasks with and without type resolution."

dependsOn(tasks.withType<Detekt>())
}

Expand Down

0 comments on commit fe5a27f

Please sign in to comment.