blob: ac7f567a2a96677d1f5cc1d8f841808e9abfe62a [file] [log] [blame]
Sergey Vasilinetscb306422018-05-22 14:39:17 -07001/*
2 * Copyright 2018 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package androidx.build
18
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -070019import androidx.build.ArtifactsPredicate.All
Sergey Vasilinetsaed74042018-08-21 17:34:32 -070020import androidx.build.ArtifactsPredicate.Benchmark
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -070021import androidx.build.ArtifactsPredicate.Exact
22import androidx.build.ArtifactsPredicate.Group
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -070023import androidx.build.Strategy.Ignore
Roberto Pereze2ce75f2018-07-27 13:14:34 -070024import androidx.build.Strategy.Prebuilts
25import androidx.build.Strategy.TipOfTree
Sergey Vasilinetscb306422018-05-22 14:39:17 -070026
Jeff Gaston9c31ae52018-07-25 15:22:32 -040027val RELEASE_RULE = docsRules("public", false) {
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050028 prebuilts(LibraryGroups.ACTIVITY, "1.0.0-alpha05")
29 prebuilts(LibraryGroups.ANNOTATION, "1.1.0-alpha02")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050030 prebuilts(LibraryGroups.APPCOMPAT, "1.1.0-alpha03")
Ian Lake452ee392019-02-21 14:29:51 -080031 prebuilts(LibraryGroups.ARCH_CORE, "2.0.0")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040032 prebuilts(LibraryGroups.ASYNCLAYOUTINFLATER, "1.0.0")
Nick Anthony23b0dff2018-12-13 14:01:12 -050033 prebuilts(LibraryGroups.BIOMETRIC, "biometric", "1.0.0-alpha03")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040034 prebuilts(LibraryGroups.BROWSER, "1.0.0")
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -050035 ignore(LibraryGroups.CAR.group, "car-moderator")
Roberto Perez77fe64e2018-10-05 16:30:46 -070036 prebuilts(LibraryGroups.CAR, "car-cluster", "1.0.0-alpha5")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050037 prebuilts(LibraryGroups.CAR, "car", "1.0.0-alpha7")
Roberto Perez022a7192018-08-01 19:57:17 -070038 .addStubs("car/stubs/android.car.jar")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040039 prebuilts(LibraryGroups.CARDVIEW, "1.0.0")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050040 prebuilts(LibraryGroups.COLLECTION, "1.1.0-alpha03")
Nick Anthony23b0dff2018-12-13 14:01:12 -050041 prebuilts(LibraryGroups.CONCURRENT, "1.0.0-alpha03")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040042 prebuilts(LibraryGroups.CONTENTPAGER, "1.0.0")
Nick Anthony0f8e3292018-11-26 19:06:45 -050043 prebuilts(LibraryGroups.COORDINATORLAYOUT, "1.1.0-alpha01")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050044 prebuilts(LibraryGroups.CORE, "core", "1.1.0-alpha05")
45 prebuilts(LibraryGroups.CORE, "core-ktx", "1.1.0-alpha05")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040046 prebuilts(LibraryGroups.CURSORADAPTER, "1.0.0")
47 prebuilts(LibraryGroups.CUSTOMVIEW, "1.0.0")
48 prebuilts(LibraryGroups.DOCUMENTFILE, "1.0.0")
49 prebuilts(LibraryGroups.DRAWERLAYOUT, "1.0.0")
Nick Anthonycb651272019-02-04 13:37:12 -050050 prebuilts(LibraryGroups.DYNAMICANIMATION, "dynamicanimation-ktx", "1.0.0-alpha01")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040051 prebuilts(LibraryGroups.DYNAMICANIMATION, "1.0.0")
52 prebuilts(LibraryGroups.EMOJI, "1.0.0")
Jonathan Scottedd185b2019-02-25 11:25:37 +000053 prebuilts(LibraryGroups.ENTERPRISE, "1.0.0-alpha01")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050054 prebuilts(LibraryGroups.EXIFINTERFACE, "1.1.0-alpha01")
55 prebuilts(LibraryGroups.FRAGMENT, "1.1.0-alpha05")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040056 prebuilts(LibraryGroups.GRIDLAYOUT, "1.0.0")
57 prebuilts(LibraryGroups.HEIFWRITER, "1.0.0")
58 prebuilts(LibraryGroups.INTERPOLATOR, "1.0.0")
Nick Anthony57515322019-01-26 12:49:14 -050059 prebuilts(LibraryGroups.LEANBACK, "1.1.0-alpha01")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040060 prebuilts(LibraryGroups.LEGACY, "1.0.0")
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -050061 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-savedstate-core")
62 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-savedstate-fragment")
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -050063 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-viewmodel-fragment")
64 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-livedata-ktx")
65 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-livedata-core-ktx")
66 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-compiler")
67 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-common-eap")
Yigit Boyar3aeedf22019-02-13 23:55:22 -080068 ignore(LibraryGroups.LIFECYCLE.group, "lifecycle-runtime-eap")
Nick Anthony54b75a92019-03-13 12:27:38 -040069 prebuilts(LibraryGroups.LIFECYCLE, "lifecycle-viewmodel-savedstate", "1.0.0-alpha01")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050070 prebuilts(LibraryGroups.LIFECYCLE, "2.1.0-alpha03")
71 prebuilts(LibraryGroups.LOADER, "1.1.0-beta01")
Nick Anthony23b0dff2018-12-13 14:01:12 -050072 prebuilts(LibraryGroups.LOCALBROADCASTMANAGER, "1.1.0-alpha01")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050073 prebuilts(LibraryGroups.MEDIA, "media", "1.1.0-alpha02")
Gyumin Sim32dacd62018-12-13 12:02:55 +090074 // TODO: Rename media-widget to media2-widget after 1.0.0-alpha06
Nick Anthony23b0dff2018-12-13 14:01:12 -050075 prebuilts(LibraryGroups.MEDIA, "media-widget", "1.0.0-alpha06")
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -050076 ignore(LibraryGroups.MEDIA2.group, "media2-widget")
77 ignore(LibraryGroups.MEDIA2.group, "media2-exoplayer")
Nick Anthony23b0dff2018-12-13 14:01:12 -050078 prebuilts(LibraryGroups.MEDIA2, "1.0.0-alpha03")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050079 prebuilts(LibraryGroups.MEDIAROUTER, "1.1.0-alpha02")
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -050080 ignore(LibraryGroups.NAVIGATION.group, "navigation-testing")
Ian Lakec03d8e22019-03-18 15:28:39 -070081 prebuilts(LibraryGroups.NAVIGATION, "2.1.0-alpha01")
Ian Lake452ee392019-02-21 14:29:51 -080082 prebuilts(LibraryGroups.PAGING, "2.1.0")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040083 prebuilts(LibraryGroups.PALETTE, "1.0.0")
84 prebuilts(LibraryGroups.PERCENTLAYOUT, "1.0.0")
Ian Lake452ee392019-02-21 14:29:51 -080085 prebuilts(LibraryGroups.PERSISTENCE, "2.0.0")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050086 prebuilts(LibraryGroups.PREFERENCE, "preference-ktx", "1.1.0-alpha04")
87 prebuilts(LibraryGroups.PREFERENCE, "1.1.0-alpha04")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040088 prebuilts(LibraryGroups.PRINT, "1.0.0")
89 prebuilts(LibraryGroups.RECOMMENDATION, "1.0.0")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050090 prebuilts(LibraryGroups.RECYCLERVIEW, "recyclerview", "1.1.0-alpha03")
Nick Anthony86b1cb32019-01-26 12:49:46 -050091 prebuilts(LibraryGroups.RECYCLERVIEW, "recyclerview-selection", "1.1.0-alpha01")
Nick Anthony0f8e3292018-11-26 19:06:45 -050092 prebuilts(LibraryGroups.REMOTECALLBACK, "1.0.0-alpha01")
Daniel Santiago Rivera9adfaba2019-02-28 14:08:13 -080093 prebuilts(LibraryGroups.ROOM, "2.1.0-alpha05")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -050094 prebuilts(LibraryGroups.SAVEDSTATE, "1.0.0-alpha02")
Nick Anthonydb044822019-03-12 15:35:59 -040095 prebuilts(LibraryGroups.SHARETARGET, "1.0.0-alpha01")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040096 prebuilts(LibraryGroups.SLICE, "slice-builders", "1.0.0")
Alan Viverette36092a52018-09-17 14:37:13 -040097 prebuilts(LibraryGroups.SLICE, "slice-builders-ktx", "1.0.0-alpha6")
Nick Anthonyba7da7a2018-09-26 10:49:24 -040098 prebuilts(LibraryGroups.SLICE, "slice-core", "1.0.0")
Sergey Vasilinets82887932018-07-24 16:30:59 -070099 // TODO: land prebuilts
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500100// prebuilts(LibraryGroups.SLICE.group, "slice-test", "1.0.0")
101 ignore(LibraryGroups.SLICE.group, "slice-test")
Nick Anthonyba7da7a2018-09-26 10:49:24 -0400102 prebuilts(LibraryGroups.SLICE, "slice-view", "1.0.0")
103 prebuilts(LibraryGroups.SLIDINGPANELAYOUT, "1.0.0")
Nick Anthony0f8e3292018-11-26 19:06:45 -0500104 prebuilts(LibraryGroups.SWIPEREFRESHLAYOUT, "1.1.0-alpha01")
Nick Anthonycb651272019-02-04 13:37:12 -0500105 prebuilts(LibraryGroups.TEXTCLASSIFIER, "1.0.0-alpha02")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -0500106 prebuilts(LibraryGroups.TRANSITION, "1.1.0-alpha02")
Nick Anthonyba7da7a2018-09-26 10:49:24 -0400107 prebuilts(LibraryGroups.TVPROVIDER, "1.0.0")
Nick Anthony0f8e3292018-11-26 19:06:45 -0500108 prebuilts(LibraryGroups.VECTORDRAWABLE, "1.1.0-alpha01")
109 prebuilts(LibraryGroups.VECTORDRAWABLE, "vectordrawable-animated", "1.1.0-alpha01")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -0500110 prebuilts(LibraryGroups.VERSIONEDPARCELABLE, "1.1.0-alpha02")
Nick Anthonyba7da7a2018-09-26 10:49:24 -0400111 prebuilts(LibraryGroups.VIEWPAGER, "1.0.0")
Nick Anthony3ddd5cf2019-03-08 09:51:37 -0500112 prebuilts(LibraryGroups.VIEWPAGER2, "1.0.0-alpha02")
Nick Anthonyba7da7a2018-09-26 10:49:24 -0400113 prebuilts(LibraryGroups.WEAR, "1.0.0")
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700114 .addStubs("wear/wear_stubs/com.google.android.wearable-stubs.jar")
Nick Anthonyba7da7a2018-09-26 10:49:24 -0400115 prebuilts(LibraryGroups.WEBKIT, "1.0.0")
Sumir Katariae63d7b12019-03-15 13:36:30 -0700116 prebuilts(LibraryGroups.WORKMANAGER, "2.0.0-rc01")
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700117 default(Ignore)
118}
119
Jeff Gaston9c31ae52018-07-25 15:22:32 -0400120val TIP_OF_TREE = docsRules("tipOfTree", true) {
Sergey Vasilinets4a92ec62018-08-28 01:28:10 -0700121 // TODO: remove once we'll figure out our strategy about it
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500122 ignore(LibraryGroups.CONCURRENT.group)
Sergey Vasilinetsc74c7fb52018-05-29 14:50:22 -0700123 default(TipOfTree)
124}
125
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700126/**
127 * Rules are resolved in addition order. So if you have two rules that specify how docs should be
128 * built for a module, first defined rule wins.
129 */
Aurimas Liutikas518ffe32018-08-06 18:42:13 -0700130fun docsRules(
131 name: String,
132 offline: Boolean,
133 init: PublishDocsRulesBuilder.() -> Unit
134): PublishDocsRules {
Jeff Gaston9c31ae52018-07-25 15:22:32 -0400135 val f = PublishDocsRulesBuilder(name, offline)
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700136 f.init()
137 return f.build()
138}
139
Jeff Gaston9c31ae52018-07-25 15:22:32 -0400140class PublishDocsRulesBuilder(private val name: String, private val offline: Boolean) {
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700141
Sergey Vasilinetsaed74042018-08-21 17:34:32 -0700142 private val rules: MutableList<DocsRule> = mutableListOf(DocsRule(Benchmark, Ignore))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700143 /**
144 * docs for projects within [groupName] will be built from sources.
145 */
146 fun tipOfTree(groupName: String) {
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700147 rules.add(DocsRule(Group(groupName), TipOfTree))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700148 }
149
150 /**
151 * docs for a project with the given [groupName] and [name] will be built from sources.
152 */
153 fun tipOfTree(groupName: String, name: String) {
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700154 rules.add(DocsRule(Exact(groupName, name), TipOfTree))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700155 }
156
157 /**
158 * docs for a project with the given [groupName] and [name] will be built from a prebuilt with
159 * the given [version].
160 */
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500161 fun prebuilts(libraryGroup: LibraryGroup, moduleName: String, version: String): Prebuilts {
Roberto Perez77fe64e2018-10-05 16:30:46 -0700162 val strategy = Prebuilts(Version(version))
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500163 rules.add(DocsRule(Exact(libraryGroup.group, moduleName), strategy))
Roberto Perez77fe64e2018-10-05 16:30:46 -0700164 return strategy
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700165 }
166
167 /**
168 * docs for projects within [groupName] will be built from prebuilts with the given [version]
169 */
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500170 fun prebuilts(libraryGroup: LibraryGroup, version: String) =
171 prebuilts(libraryGroup, Version(version))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700172
173 /**
174 * docs for projects within [groupName] will be built from prebuilts with the given [version]
175 */
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500176 fun prebuilts(libraryGroup: LibraryGroup, version: Version): Prebuilts {
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700177 val strategy = Prebuilts(version)
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500178 rules.add(DocsRule(Group(libraryGroup.group), strategy))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700179 return strategy
180 }
181
182 /**
183 * defines a default strategy for building docs
184 */
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700185 fun default(strategy: Strategy) {
186 rules.add(DocsRule(All, strategy))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700187 }
188
189 /**
190 * docs for projects within [groupName] won't be built
191 */
192 fun ignore(groupName: String) {
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700193 rules.add(DocsRule(Group(groupName), Ignore))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700194 }
195
196 /**
197 * docs for a specified project won't be built
198 */
199 fun ignore(groupName: String, name: String) {
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700200 rules.add(DocsRule(Exact(groupName, name), Ignore))
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700201 }
202
Jeff Gaston9c31ae52018-07-25 15:22:32 -0400203 fun build() = PublishDocsRules(name, offline, rules)
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700204}
205
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700206sealed class ArtifactsPredicate {
207 abstract fun apply(inGroup: String, inName: String): Boolean
208 object All : ArtifactsPredicate() {
209 override fun apply(inGroup: String, inName: String) = true
210 }
211 class Group(val group: String) : ArtifactsPredicate() {
212 override fun apply(inGroup: String, inName: String) = inGroup == group
213 override fun toString() = "\"$group\""
214 }
215 class Exact(val group: String, val name: String) : ArtifactsPredicate() {
216 override fun apply(inGroup: String, inName: String) = group == inGroup && name == inName
217 override fun toString() = "\"$group\", \"$name\""
218 }
Sergey Vasilinetsaed74042018-08-21 17:34:32 -0700219
220 object Benchmark : ArtifactsPredicate() {
221 override fun apply(inGroup: String, inName: String) = inName.endsWith("-benchmark")
222 }
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700223}
224
225data class DocsRule(val predicate: ArtifactsPredicate, val strategy: Strategy) {
226 override fun toString(): String {
227 if (predicate is All) {
228 return "default($strategy)"
229 }
230 return when (strategy) {
231 is Prebuilts -> "prebuilts($predicate, \"${strategy.version}\")"
232 is Ignore -> "ignore($predicate)"
233 is TipOfTree -> "tipOfTree($predicate)"
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700234 }
235 }
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700236}
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700237
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700238sealed class Strategy {
239 object TipOfTree : Strategy()
240 object Ignore : Strategy()
241 class Prebuilts(val version: Version) : Strategy() {
242 var stubs: MutableList<String>? = null
243 fun addStubs(path: String) {
244 if (stubs == null) {
245 stubs = mutableListOf()
246 }
247 stubs!!.add(path)
248 }
249
250 override fun toString() = "Prebuilts(\"$version\")"
Jeff Gaston98f1b242019-01-02 16:32:07 -0500251 fun dependency(extension: SupportLibraryExtension): String {
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500252 return "${extension.mavenGroup?.group}:${extension.project.name}:$version"
Jeff Gaston98f1b242019-01-02 16:32:07 -0500253 }
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700254 }
255}
256
Jeff Gaston9c31ae52018-07-25 15:22:32 -0400257class PublishDocsRules(val name: String, val offline: Boolean, private val rules: List<DocsRule>) {
Jeff Gaston98f1b242019-01-02 16:32:07 -0500258 fun resolve(extension: SupportLibraryExtension): DocsRule? {
259 val mavenGroup = extension.mavenGroup
Oussama Ben Abdelbaki34f21e02019-02-27 13:38:27 -0500260 return if (mavenGroup == null) null else resolve(mavenGroup.group, extension.project.name)
Jeff Gaston98f1b242019-01-02 16:32:07 -0500261 }
262
Sergey Vasilinetsf38083e2018-05-29 17:10:15 -0700263 fun resolve(groupName: String, moduleName: String): DocsRule {
264 return rules.find { it.predicate.apply(groupName, moduleName) } ?: throw Error()
Sergey Vasilinetscb306422018-05-22 14:39:17 -0700265 }
Chris Craik51f6bc22018-05-23 18:11:26 -0700266}