blob: d90569f1c8c7de740191a8b873cfa751b6e4c1c9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
/*
* Copyright 2024 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.build.docs
import org.gradle.api.DefaultTask
import org.gradle.api.GradleException
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.tasks.TaskAction
/**
* Verifies that the text of the [projectPathProvider] can be found in the [tipOfTreeBuildFile] to
* enforce that projects enable docs generation.
*/
@CacheableTask
abstract class CheckTipOfTreeDocsTask : DefaultTask() {
@get:[InputFile PathSensitive(PathSensitivity.NONE)]
abstract val tipOfTreeBuildFile: RegularFileProperty
@get:Input
abstract val projectPathProvider: Property<String>
@get:Input
abstract val projectIsKmp: Property<Boolean>
@TaskAction
fun exec() {
val projectPath = projectPathProvider.get()
// Make sure not to allow a partial project path match, e.g. ":activity:activity" shouldn't
// match ":activity:activity-ktx", both need to be listed separately.
val projectDependency = "project(\"$projectPath\")"
val isKmp = projectIsKmp.get()
val fullExpectedText = if (isKmp) {
// Check that KMP projects are listed as KMP
"kmpDocs($projectDependency)"
} else {
// Don't require `docs($projectDependency)` because some projects are present as stubs.
projectDependency
}
val fileContents = tipOfTreeBuildFile.asFile.get().readText()
if (!fileContents.contains(fullExpectedText)) {
// If this is a KMP project, check if it is present but configured as non-KMP
val message = if (isKmp && fileContents.contains(projectDependency)) {
"KMP project $projectPath needs 'kmpDocs' in docs-tip-of-tree/build.gradle\n\n" +
"Update the entry for $projectPath in docs-tip-of-tree/build.gradle to " +
"'$fullExpectedText'."
} else {
"Project $projectPath not found in docs-tip-of-tree/build.gradle\n\n" +
"Use the project creation script (development/project-creator/" +
"create_project.py) when setting up a project to make sure all required " +
"steps are complete.\n\n" +
"The project should be added to docs-tip-of-tree/build.gradle as " +
"\'$fullExpectedText\'.\n\n" +
"If this project should not have published refdocs, first check that the " +
"library type listed in its build.gradle file is accurate. If it is, opt out " +
"of refdoc generation using \'doNotDocumentReason = \"some reason\"\' in the " +
"'androidx' configuration section (this is not common)."
}
throw GradleException(message)
}
}
}
|
