Skip to content

400 -- added descriptions to Lint tasks #421

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ abstract class FixGradleLintTask extends DefaultTask implements VerificationTask


FixGradleLintTask() {
description = 'Fixes lint violations in the build files'
infoBrokerAction = new GradleLintInfoBrokerAction(project)
userDefinedListeners.convention([])
outputs.upToDateWhen { false }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ class GradleLintPluginTaskConfigurer extends AbstractLintPluginTaskConfigurer {
def autoLintTask = project.tasks.register(AUTO_LINT_GRADLE, LintGradleTask)
autoLintTask.configure {
group = LINT_GROUP
description = 'Runs lint on the build files automatically'
listeners = lintExt.listeners
projectRootDir.set(project.rootDir)
notCompatibleWithConfigurationCache("Gradle Lint Plugin is not compatible with configuration cache because it requires project model")
Expand All @@ -68,6 +69,7 @@ class GradleLintPluginTaskConfigurer extends AbstractLintPluginTaskConfigurer {
def criticalLintTask = project.tasks.register(CRITICAL_LINT_GRADLE, LintGradleTask)
criticalLintTask.configure {
group = LINT_GROUP
description = 'Runs lint on the build files and fails the build if any critical issues are found'
onlyCriticalRules.set(true)
projectRootDir.set(project.rootDir)
notCompatibleWithConfigurationCache("Gradle Lint Plugin is not compatible with configuration cache because it requires project model")
Expand All @@ -76,12 +78,14 @@ class GradleLintPluginTaskConfigurer extends AbstractLintPluginTaskConfigurer {

def fixTask = project.tasks.register(FIX_GRADLE_LINT, FixGradleLintTask)
fixTask.configure {
description = 'Runs lint on the build files and attempts to fix any issues found'
userDefinedListeners.set(lintExt.listeners)
notCompatibleWithConfigurationCache("Gradle Lint Plugin is not compatible with configuration cache because it requires project model")
}

def fixTask2 = project.tasks.register(FIX_LINT_GRADLE, FixGradleLintTask)
fixTask2.configure {
description = 'Runs lint on the build files and attempts to fix any issues found'
userDefinedListeners.set(lintExt.listeners)
notCompatibleWithConfigurationCache("Gradle Lint Plugin is not compatible with configuration cache because it requires project model")
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ abstract class GradleLintReportTask extends DefaultTask implements VerificationT
})
reports.create('xml')
reports.create('html')
description = 'Generates a report of lint violations in the build files'
outputs.upToDateWhen { false }
group = 'lint'
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ abstract class LintGradleTask extends DefaultTask {
LintGradleTask() {
failOnWarning.convention(false)
onlyCriticalRules.convention(false)
description = 'Runs lint on the build files'
group = 'lint'
try {
def method = Task.getMethod("notCompatibleWithConfigurationCache")
Expand Down