From ca3ae019d9c595a9f2f388194314e4ec54b07f35 Mon Sep 17 00:00:00 2001
From: Zac Sweers <pandanomic@gmail.com>
Date: Thu, 9 Nov 2023 18:13:49 -0500
Subject: [PATCH] Deployed 6aa03c2 with MkDocs version: 1.4.2

---
 changelog/index.html     |  19 +++++++++++++++++++
 search/search_index.json |   2 +-
 sitemap.xml.gz           | Bin 208 -> 208 bytes
 3 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/changelog/index.html b/changelog/index.html
index 7717a886e..b3a0a22af 100644
--- a/changelog/index.html
+++ b/changelog/index.html
@@ -378,6 +378,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#0115" class="md-nav__link">
+    0.11.5
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#0114" class="md-nav__link">
     0.11.4
@@ -1100,6 +1107,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#0115" class="md-nav__link">
+    0.11.5
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#0114" class="md-nav__link">
     0.11.4
@@ -1762,6 +1776,11 @@
 
 
 <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">&para;</a></h1>
+<h2 id="0115">0.11.5<a class="headerlink" href="#0115" title="Permanent link">&para;</a></h2>
+<p><em>2023-11-09</em></p>
+<ul>
+<li>Support AGP <code>8.3.0-alpha13</code>.</li>
+</ul>
 <h2 id="0114">0.11.4<a class="headerlink" href="#0114" title="Permanent link">&para;</a></h2>
 <p><em>2023-11-08</em></p>
 <ul>
diff --git a/search/search_index.json b/search/search_index.json
index 4927458b7..039dbdff0 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"slack-gradle-plugin","text":"<p>This repository contains the core Gradle plugin and associated logic used for Slack\u2019s Android app.</p> <p>This repo is effectively read-only and does not publish artifacts to Maven Central. We develop these in the open to knowledge-share with the community.</p> <p>As such, our issue tracker is closed and we don\u2019t normally accept external PRs, but we welcome your questions in the discussions section of the project!</p> <p>We may later publish some of these components. If you\u2019re interested in this, feel free to raise in a discussions post or vote for existing suggestions.</p>"},{"location":"#highlights","title":"Highlights","text":""},{"location":"#common-project-configuration","title":"Common project configuration","text":"<p>The <code>slack.base</code> plugin offers common configuration for all projects implementing it, covering a wide spectrum of Android, Kotlin, and Java configurations.</p> <p>This includes a whole host of things! - Common Android configuration (single variant libraries, disabling unused features, compose, etc). - Common Kotlin configuration (freeCompilerArgs, JVM target, etc). - Common Java configuration (toolchains, release versions, etc). - Common annotation processors. - SlackExtension (see next section). - Formatting (via Spotless). - Platforms and BOM dependencies (see \u201cPlatform plugins\u201d section below). - Common lint checks (both on Android and plain JVM projects).</p> <p>Full docs can be found in the architecture docs.</p>"},{"location":"#feature-dsl","title":"Feature DSL","text":"<p>To ease use and configuration of common features in projects, we expose a <code>slack</code> DSL in projects that allows for configuration of these in a semantically easy and boilerplate-free way. This is controlled via <code>SlackExtension</code>.</p> <pre><code>slack {\nfeatures {\ndagger()\nmoshi(codegen = true)\n}\nandroid {\nfeatures {\nrobolectric()\n}\n}\n}\n</code></pre> <p>A major benefit of this is that we can intelligently configure features and avoid applying costly plugins like Kapt unless they\u2019re actually needed for a specific feature, such as Java injections in projects using Dagger. Since this is pure code, we can also propagate deprecated behavior by deprecating the corresponding functions in the DSL.</p>"},{"location":"#platform-plugins","title":"Platform plugins","text":"<p><code>Platforms.kt</code> contains an implementation that sources a <code>VersionCatalog</code> and applies it to a Gradle platform project. This allows us to effectively treat our versions catalog as a BOM and apply it to all projects in the consuming repo and reduce dependency version stratification.</p>"},{"location":"#thermal-throttling-capture","title":"Thermal throttling capture","text":"<p>MacBooks can suffer thermal throttling and result in poor build performance. We built instrumentation for this to capture these and include them in our build scans to better understand their impact. We support both Intel and Apple Silicon macs now and contain this implementation in <code>ThermalsWatcher.kt</code>. This also includes helpful charting APIs for visualizing the data (courtesy of our friends at Square).</p>"},{"location":"#better-properties","title":"Better Properties","text":"<p>Gradle\u2019s built-in property support is limited and has surprising behavior, so we have our own system on top of it that has consistent precedence, <code>local.properties</code> support, project-local <code>gradle.properties</code>, and configuration caching support. Check out <code>safeProperty()</code> in <code>PropertyUtil.kt</code>.</p>"},{"location":"#dependency-rake","title":"Dependency Rake","text":"<p><code>DependencyRake.kt</code> contains an extension to the <code>gradle-dependency-analysis-plugin</code> that applies its advice to a project to automatically optimize it and rake dependencies.</p>"},{"location":"#module-stats-aka-mod-score","title":"Module Stats (aka \u201cMod Score\u201d)","text":"<p>As a part of our modularization efforts, we developed a scoring mechanism for modules that we could use as a measure of their \u201cmodularization\u201d. This includes a number of metrics and weighs them in a formula to compute a score. This includes LoC, language mixtures, and build graph centrality. This logic is under the <code>slack.stats</code> package.</p>"},{"location":"#robolectric-jars-management","title":"Robolectric Jars Management","text":"<p>Robolectric uses preinstrumented Android API jars that live on maven central. While it can handle downloading of these automatically, we found this implementation to be brittle and unreliable, so we built our own version of it that handles downloading these into a local <code>.cache</code> directory. This implementation lives in <code>UpdateRobolectricJarsTask.kt</code> and that task is configured to be a dependency of all <code>Test</code> tasks.</p>"},{"location":"#bootstrap","title":"Bootstrap","text":"<p>We try to simplify and streamline the bootstrap process for both local development and on CI. This involves computing optimized JVM arguments for the Gradle and Kotlin daemons (which differ between CI and local) as well as toe-holds for future customizations. This logic lives in <code>BootstrapTask.kt</code>.</p>"},{"location":"#permission-checks","title":"Permission Checks","text":"<p>To avoid accidentally checking in any new, unexpected manifest permissions, we have a <code>CheckManifestPermissionsTask</code> that compares the final merged manifest\u2019s permissions to an allow list of known permissions. This is allow list is checked in and expected to be guarded by a <code>CODEOWNERS</code> watch and will fail the build if they differ.</p> <pre><code>slack {\nandroid {\napp {\npermissionAllowlist {\nif (name == \"externalRelease\") {\nsetAllowlistFile(file(\"permissionsAllowlist.txt\"))\n}\n}\n}\n}\n}\n</code></pre>"},{"location":"#apk-versioning-computers","title":"APK Versioning Computers","text":"<p>AGP offers new property-based APIs for computing APK version codes and version names. We use this to compute information from different inputs (CI build number, git state, etc) and control this logic in <code>ApkVersioningPlugin.kt</code>.</p>"},{"location":"#check-dependency-versions","title":"Check dependency versions","text":"<p>Sometimes a dependency update may bring with it a surprise update to a transitive dependency that we also declare. In order to avoid this happening unexpectedly, the <code>CheckDependencyVersionsTask</code> checks that any transitive dependency versions that also correspond to a version declared in our <code>VersionCatalog</code> match the version there. It\u2019s ok if they don\u2019t, but the author just need to update the version in the catalog too to be explicit (or investigate further if it\u2019s an unwanted surprise!).</p>"},{"location":"#agp-handlers","title":"AGP Handlers","text":"<p>AGP occasionally contains new or breaking API changes that we want to handle gracefully in early testing. We regularly test against newer preview versions of AGP so we can\u2019t just hardcode in new APIs and expect them to work everywhere. To handle this, we have an <code>AgpHandler</code> interface that can be used to abstract these new APIs in a backward-compatible way. Then we ship implementations of this as different artifacts that are built against different AGP versions. Then, at runtime, we pick the appropriate instance (via service loading) to use for the current AGP version being used in that build.</p>"},{"location":"#detekt-baselining","title":"Detekt baselining","text":"<p>Detekt is a static analysis tool that we use to check for common issues in our code. We use one global baseline file for baselined issues (when introducing new checks or updates), but Detekt doesn\u2019t currently support this easily. So, we built <code>MergeDetektBaselinesTask</code> to merge all the generated baselines from each subproject into a single global baseline.</p>"},{"location":"#misc-tools","title":"Misc tools","text":"<p>There are a ton of miscellaneous tools, utilities, and glue code for Gradle (and various plugins) sprinkled throughout this project.</p>"},{"location":"#usage-requirements","title":"Usage requirements","text":"<p>SGP expects there to be a <code>libs</code> version catalog.</p> <p>The following versions are required to be set the above catalog. Their docs can be found in <code>SlackVersions.kt</code>. - <code>jdk</code></p> <p>For Android projects, some extra definitions need to be defined - <code>libs.versions.toml</code> libraries     - <code>google-coreLibraryDesugaring</code> - the core library desugaring libraries to use with L8. - <code>gradle.properties</code> properties     - <code>slack.compileSdkVersion</code>     - <code>slack.targetSdkVersion</code>     - <code>slack.minSdkVersion</code></p> <p>The following plugins are applied by default but can be disabled if you don\u2019t need them. - Gradle\u2019s test retry \u2013 <code>slack.auto-apply.test-retry</code>     - By default, this uses the Gradle test-retry plugin, but can be configured to use the Gradle Enterprise plugin\u2019s implementation instead by setting the <code>slack.test.retry.pluginType</code> property to <code>GE</code>. - Spotless \u2013 <code>slack.auto-apply.spotless</code> - Detekt \u2013 <code>slack.auto-apply.detekt</code> - NullAway \u2013 <code>slack.auto-apply.nullaway</code> - Android Cache Fix \u2013 <code>slack.auto-apply.cache-fix</code></p>"},{"location":"#commit-hooks","title":"Commit hooks","text":"<p>The <code>installCommitHooks</code> task can install commit hooks for formatting kotlin and java files. They expect binaries to be in <code>&lt;root&gt;/config/git/hooks</code> and it\u2019s highly recommended to enable git-lfs for these objects. These binaries can be downloaded via the <code>updateKtfmt</code>, <code>updateGjf</code>, etc tasks.</p>"},{"location":"#license","title":"License","text":"<pre><code>Copyright 2022 Slack Technologies, LLC\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n</code></pre>"},{"location":"architecture/","title":"Architecture","text":"<p>SGP consists of three Gradle plugins and some associated helper artifacts.</p>"},{"location":"architecture/#slackrootplugin","title":"<code>SlackRootPlugin</code>","text":"<p>This is the root plugin that is applied to the root project of a multi-project build.</p> <pre><code>plugins {\nid(\"com.slack.gradle.root\")\n}\n</code></pre> <p>Its responsibilities include:</p> <ul> <li>Registering the <code>SlackTools</code> build service.</li> <li>Setting up global configuration (i.e. global lifecycle tasks, download tasks, etc).</li> <li>Validating the JDK matches the expected JDK defined in <code>libs.versions.toml</code>.</li> <li>Configure git (hooks, ignored revisions, etc).</li> <li>(If running on macOS) Validating the build isn\u2019t running in Rosetta mode.</li> </ul>"},{"location":"architecture/#slackbaseplugin","title":"<code>SlackBasePlugin</code>","text":"<p>This is the base plugin that is applied to all projects (including the root project).</p> <pre><code>plugins {\nid(\"com.slack.gradle.base\")\n}\n</code></pre> <p>Its responsibilities include:</p> <ul> <li>Configuring formatters for Spotless.</li> <li>Configuring the buildscript and dependency classpaths. This includes \u201cfixing\u201d any known bad dependencies (Hamcrest and CheckerFramework are a mess), failing on non-reproducible dependency declarations.</li> <li>Running standard subproject configurations via <code>StandardProjectConfigurations</code>.</li> <li>Configuring unit tests via <code>UnitTests</code>. This also includes configuring the Gradle test retry plugin, if enabled.</li> <li>Configuring NullAway, if enabled.</li> <li>Configuring Skippy.</li> <li>Configuring Mod Score tasks.</li> </ul>"},{"location":"architecture/#standardprojectconfigurations","title":"<code>StandardProjectConfigurations</code>","text":"<p>This class warrants special mention as it is responsible for the bulk of the configuration applied to projects SGP manages.</p> <ul> <li>Creates and exposes the <code>slack</code> extension DSL.</li> <li>Applies common configurations.</li> <li>This largely just sets up the dependency sorter plugin.</li> <li>Applies common JVM configurations.</li> <li>Applies common Kotlin configurations.</li> </ul>"},{"location":"architecture/#jvm-configurations","title":"JVM Configurations","text":"<p>All JVM projects (Android, Java, Kotlin) receive some common configuration for their JVM tasks.</p>"},{"location":"architecture/#common","title":"Common","text":"<ul> <li>Applies the repo\u2019s platform project, if any.</li> <li>Applies any BOM dependencies to platform-configurable configurations.</li> <li>Configures the dependency analysis gradle plugin and <code>DependencyRake</code>.</li> <li>Applies common annotations and common test bundles from version catalogs.</li> <li>Fails on non-androidx support library dependencies.</li> <li>Configure common annotations processors.</li> <li>This logic is largely in <code>StandardProjectConfigurations.configureAnnotationProcessors()</code> and <code>StandardProjectConfigurations.APT_OPTION_CONFIGS</code>, which seeks to apply common configs for known processors like Dagger and Moshi.</li> </ul>"},{"location":"architecture/#java","title":"Java","text":"<p>Java projects are fairly simple. Note that these are applied on all projects that apply the <code>java</code> plugin, which is most of them!</p> <ul> <li>They are just configured to ensure their source/target compatibility is set to the repo\u2019s JVM target.</li> <li>In non-android projects, <code>JavaCompile</code> tasks have their <code>options.release</code> property set to this as well.</li> <li>Gradle toolchains are used to manage the JDK used for <code>JavaCompile</code> tasks in non-android projects to ensure consistency.</li> <li>All <code>JavaCompile</code> tasks have <code>-parameters</code> added to <code>options.compilerArgs</code> for better static analysis and annotation processing support.</li> <li>If opted-in, error-prone and nullaway are applied and set up with the project with common configurations (configured checks, ignoring build dirs, etc).</li> <li>SGP supports Error-Prone\u2019s auto-patching mode via enabling the <code>slack.epAutoPatch</code> property.</li> </ul>"},{"location":"architecture/#android","title":"Android","text":"<ul> <li>Configures AndroidTest APK aggregation with Skippy support.</li> <li>Applies the Android cache fix plugin, if enabled.</li> <li>Configures common AGP extensions (both legacy extensions and new Component extensions).</li> <li>Disables unused/irrelevant variants. SGP is single-variant for library projects by default.</li> <li>Disables android tests on projects unless opted in.</li> <li>Disables unit tests on app projects by default (we use the app project as just a shell project for producing an APK).</li> <li>Configures <code>compileOptions</code>, <code>defaultConfig</code>, compileSdk/targetSdk/minSdk/ndkVersion, etc.<ul> <li>Enables <code>vectorDrawables.useSupportLibrary</code>.</li> </ul> </li> <li>Enables core library desugaring.</li> <li>Configures common <code>testOptions</code> like orchestrator, <code>unitTests</code>, etc.<ul> <li><code>unitTests.isReturnDefaultValues</code> is always enabled for convenience.</li> <li><code>unitTests.isIncludeAndroidResources</code> is only enabled if robolectric is enabled on the project, as this is expensive to enable.</li> <li>Set up unit test <code>Test</code> tasks to depend on the <code>UpdateRobolectricJarsTask</code> if robolectric is enabled.</li> </ul> </li> <li>Patches objenesis dependency versions due to weird transitive dependencies in android test classpaths.</li> <li>Configures <code>com.android.library</code> and <code>com.android.application</code> projects. <code>com.android.test</code> is supported but somewhat limited.</li> <li>Application projects\u2026</li> <li>have their packaging config set up with some convenience common exclusions and handling common <code>jniLibs</code> handling.</li> <li>have v3 and v4 signing enabled by default.</li> <li>are configured with <code>PermissionChecks</code>.</li> <li>are configured with the Bugsnag gradle plugin, if enabled.</li> <li>Library projects\u2026</li> <li>are configured with an automatic <code>android.namespace</code>, if none is manually specified in the buildscript. The namespace is inferred from the project\u2019s Gradle path.</li> <li>are single-variant by default, set to <code>release</code>.</li> </ul>"},{"location":"architecture/#kotlin-configurations","title":"Kotlin Configurations","text":"<p>Kotlin projects are configured with KGP and Detekt in mind. SGP supports configuring Android, JVM, Multiplatform, and Compose Multiplatform projects. Multiplatform for targets other than JVM/android is limited at the moment.</p> <p>Common configurations include:</p> <ul> <li>Setting computed kotlin daemon JVM args.</li> <li>Setting the <code>jvmToolchain</code> to align with the repo\u2019s JDK target.</li> <li>Configuring <code>KotlinCompilation</code> tasks with common configurations.</li> <li>Enabling <code>allWarningsAsErrors</code>.</li> <li>Adding free compiler args to <code>freeCompilerArgs</code>.<ul> <li>If a JVM compilation, add extra JVM args + set <code>jvmTarget</code> and <code>javaParameters</code>.</li> <li>Dynamic, dependency-based compiler args are also set via <code>StandardProjectConfigurations.configureFreeKotlinCompilerArgs()</code>. This is an annoying thing to have to do, but necessary because kotlinc will complain if you add opt-ins that are not recognized by any dependencies on that classpath.</li> </ul> </li> <li>Enabling K2 testing.</li> <li>Configure Detekt, if enabled, via <code>DetektTasks</code>.</li> <li>Configure Lint if not an Android project via the <code>com.android.lint</code> plugin and <code>LintTasks</code>.</li> <li>Configure the <code>src/{variant}/kotlin</code> source set in android projects, as  these are still not automatically enabled.</li> <li>Prevent use of the deprecated <code>android.extensions</code> extension.</li> <li>Configure kapt (if requested) with common configuration</li> <li><code>correctErrorTypes</code> is set to true for better error messages.</li> <li><code>mapDiagnosticLocations</code> is set to false because it\u2019s broken.</li> <li>Unless opted-in, disables kapt in tests due to this.</li> </ul>"},{"location":"architecture/#apkversioningplugin","title":"ApkVersioningPlugin","text":"<pre><code>plugins {\nid(\"com.slack.gradle.apk-versioning\")\n}\n</code></pre> <p>This plugin is applied in Android application projects and is solely to configure the <code>versionCode</code> and <code>versionName</code> of APKs based on git and Gradle property inputs.</p> <p>The following properties are sourced</p> <pre><code>versionMajor=...\nversionMinor=...\nversionPatch=...\n</code></pre> <p>This also adds a <code>generateVersionProperties</code> task that is more or less only relevant for Slack\u2019s internal CI.</p>"},{"location":"architecture/#agp-handlers","title":"AGP Handlers","text":"<p>SGP is designed to work with multiple versions of AGP at a time, albeit only for forward compatibility and testing reasons. Generally SGP will only be tested against the latest stable version of AGP. To support multiple beta/canary versions of upcoming AGP versions, SGP has an API called <code>AgpHandler</code>, which is intended to be an AGP-agnostic common interface for configuring AGP projects across breaking API (source or binary) changes. When a new such change is introduced, we create an <code>AgpHandler{version}</code> artifact and implementation with that AGP version as its minimum. At runtime, SGP loads the relevant <code>AgpHandler</code> instance for the AGP version it is running against and relevant APIs use this instance via <code>SlackTools</code> to interact with them in a version-agnostic way. These aren\u2019t always needed so there may be times when there are no implementations needed for the current suite of AGP versions.</p> <p>An example handler for AGP 8.0 looks like this.</p> <pre><code>// AutoService makes it available via ServiceLoader\n// The factory should always be AGP-api agnostic.\nclass AgpHandler80 : AgpHandler {\n@Suppress(\"DEPRECATION\")\noverride val agpVersion: String\nget() = com.android.builder.model.Version.ANDROID_GRADLE_PLUGIN_VERSION\n\n@AutoService(AgpHandlerFactory::class)\nclass Factory : AgpHandlerFactory {\noverride val minVersion: VersionNumber = VersionNumber.parse(\"8.0.0\")\n\n@Suppress(\"DEPRECATION\")\noverride fun currentVersion(): String =\ncom.android.builder.model.Version.ANDROID_GRADLE_PLUGIN_VERSION\n\noverride fun create(): AgpHandler {\nreturn AgpHandler80()\n}\n}\n}\n</code></pre>"},{"location":"bootstrap/","title":"Bootstrap","text":"<p>Bootstrap is a tool for bootstrapping local dev environments. This is usually used in tandem with a bootstrap bash script that runs the <code>./gradlew bootstrap</code> task and any other repo-specific setups.</p> <p>The core implementation lives in <code>BootstrapTask.kt</code>.</p> <p>At a high level, bootstrap is mostly focused on configuring the JDK and daemon environments. Gradle has extremely limited configurability for the Gradle daemon, and we want to optimize the JDK for available space on different developer machines. To support this, we compute optimal daemon jvm arguments in bootstrap and write them to the user\u2019s home <code>~/.gradle/gradle.properties</code> to override repo-specific settings with client-side properties.</p> <p>For the JDK, it requests the JDK toolchain from Gradle\u2019s first-party APIs. This includes allowing Gradle to download the JDK if it\u2019s missing, which is useful for getting developers set up and running faster.</p> <p>Bootstrap is also useful on CI for its ability to scale available memory to the machine it\u2019s running on, so we generally run it as a preflight step for all of our CI jobs too.</p> <p>Finally, there are some other specific things it does to optimize things:</p> <ul> <li>Disable Gradle file watching on CI as it\u2019s not necessary there.</li> <li>Configure specific GC and heap args for optimized use in Gradle builds (favoring larger young generation spaces).</li> <li>Configure a fixed-size heap for CI to avoid time spent growing the heap.</li> </ul>"},{"location":"changelog/","title":"Changelog","text":""},{"location":"changelog/#0114","title":"0.11.4","text":"<p>2023-11-08</p> <ul> <li>Detekt baselines are now generated into their corresponding projects. This matches how we handle lint baselines, and global baselines are no longer supported.</li> <li>You do now need to specify a <code>slack.detekt.baseline-file-name</code> property to indicate what the simple file name should be. This is evaluated against <code>project.layout.projectDirectory.file(...)</code>. This replaces the previous <code>slack.detekt.baseline</code> property.</li> <li>Build against Kotlin <code>1.9.20</code>.</li> <li>Build against AGP <code>8.1.3</code>.</li> <li>Build against Compose Multiplatform <code>1.5.10</code>.</li> </ul>"},{"location":"changelog/#0113","title":"0.11.3","text":"<p>2023-11-02</p> <ul> <li>Support Robolectric 4.11 jars for Android API 34.</li> </ul>"},{"location":"changelog/#0112","title":"0.11.2","text":"<p>2023-10-30</p> <ul> <li>Make detekt and lint baselines default to <code>null</code> if their property values are blank.</li> <li>No longer publish monkeypatch artifact as it\u2019s no longer necessary.</li> </ul>"},{"location":"changelog/#0111","title":"0.11.1","text":"<p>2023-10-22</p> <ul> <li>Add new <code>sgp.isTestLibrary</code> property to indicate if a library is a test library. Note that projects that are named <code>test-fixtures</code> are implicitly considered test libraries.</li> <li>Fix: Don\u2019t impose <code>VisibleForTests</code> lint on test libraries.</li> </ul>"},{"location":"changelog/#0110","title":"0.11.0","text":"<p>2023-10-22</p> <ul> <li>Revamp some lint configuration and best-effort support KMP projects.</li> <li>Remove <code>slack.lint.update-baselines</code> property in favor of AGP\u2019s modern <code>updateBaselines</code> task.</li> <li>Remove hidden <code>ImplicitSamInstance</code> lint config.</li> <li>Disable newer issues for dependency checks.</li> </ul>"},{"location":"changelog/#01011","title":"0.10.11","text":"<p>2023-10-19</p> <ul> <li>Support AGP <code>8.3.0-alpha08</code>.</li> <li>Build against Gradle <code>8.4</code>.</li> <li>Build against compose-multiplatform <code>1.5.3</code>.</li> </ul>"},{"location":"changelog/#01010","title":"0.10.10","text":"<p>2023-10-02</p> <ul> <li>Make debug builds everywhere (local and CI) use consistent version codes and version names. This way remote build cache entries for them are compatible.</li> <li>Default debug version code is governed by <code>slack.gradle.debugVersionCode</code> and defaults to <code>90009999</code>.</li> <li>Default version name user suffix is governed by <code>slack.gradle.debugUserString</code> and defaults to <code>debug</code>.</li> <li>Non-debug build types are the same as before.</li> <li>Remove a noisy lifecycle log around lint variant selection.</li> <li>Build against Bugsnag Gradle Plugin <code>8.1.0</code>.</li> </ul>"},{"location":"changelog/#0109","title":"0.10.9","text":"<p>2023-09-28</p> <ul> <li>Don\u2019t disable caching on MergeAssets tasks by default. Leave that to consuming repos.</li> <li>Update permission allowlist API to use a <code>allowListFile</code> file property instead.</li> <li>Don\u2019t exclude coroutines\u2019 debug probes in debug build packaging.</li> <li>Support AGP 8.3.0-alpha05+.</li> <li>Build against Wire <code>4.9.1</code>.</li> <li>Build against Compose Multiplatform <code>1.5.2</code>.</li> <li>Update to Oshi <code>6.4.6</code>.</li> </ul>"},{"location":"changelog/#0108","title":"0.10.8","text":"<p>2023-09-22</p> <ul> <li>Fix: Don\u2019t apply boms to the <code>coreLibraryDesugaring</code> configuration.</li> <li>Enhancement: Set Kotlin <code>compilerOptions.moduleName</code> to a dashified version of the Gradle project path.</li> <li>Update MoshiX to <code>0.24.3</code></li> <li>Compile against Anvil <code>2.4.8</code>.</li> <li>Compile against CM <code>1.5.1</code>.</li> <li>Compile against DAGP <code>1.22.0</code>.</li> <li>Compile against redacted-compiler-plugin <code>1.6.1</code>.</li> </ul>"},{"location":"changelog/#0107","title":"0.10.7","text":"<p>2023-08-29</p> <ul> <li>Fix: Don\u2019t apply BOMs to testApi configurations.</li> </ul>"},{"location":"changelog/#0106","title":"0.10.6","text":"<p>2023-08-29</p> <ul> <li>New: Publish a generic Tracing API under the <code>sgp-tracing</code> artifact ID. We use this internally to collect extra build metadata, but it\u2019s generic enough for general use. Not currently used in slack-plugin yet.</li> <li>Add <code>sgp.android.buildToolsVersionOverride</code> property to override the default build tools version in Android.</li> <li>Migrate to <code>AndroidPluginVersion</code> API in <code>AgpHandler</code>.</li> <li>Fix a few more deprecated Gradle API usages.</li> <li>Build against AGP <code>8.1.1</code>.</li> <li>Build against Spotless <code>6.21.0</code>.</li> <li>Build against Compose Multiplatform <code>1.5.0</code>.</li> <li>Update to Kotlin <code>1.9.10</code>.</li> <li>Update to KSP <code>1.9.10-1.0.13</code>.</li> <li>Update to RxJava <code>3.1.7</code>.</li> <li>Update to kotlin-cli-util <code>2.2.1</code>.</li> <li>Update to Oshi <code>6.4.5</code>.</li> <li>Update to Wire <code>4.8.1</code></li> <li>Update to DAGP <code>1.21.0</code>.</li> <li>Update to Gradle <code>8.3</code>.</li> </ul>"},{"location":"changelog/#0105","title":"0.10.5","text":"<p>2023-08-15</p> <ul> <li>Fix: Better support <code>com.android.test</code> projects in a few ways</li> <li>No longer apply lint configurations as they don\u2019t support them.</li> <li>No longer apply DAGP as it doesn\u2019t support them yet.</li> <li>No longer apply unit test configurations as they don\u2019t have unit tests.</li> <li>Build against Gradle 8.3 + fix a few deprecated <code>Project.buildDir</code> API usages.</li> <li>Update <code>kotlin-cli-util</code> to <code>2.1.0</code>.</li> </ul>"},{"location":"changelog/#0104","title":"0.10.4","text":"<p>2023-08-10</p> <ul> <li>New: New DSL API for enabling Android resources.</li> </ul> <p>This streamlines configuration of enabling <code>androidResources</code> and enforces use of a resource prefix to avoid conflicts.</p> <p>May your avatars never be wrongly sized again.</p> <pre><code>slack {\nandroid {\nfeatures {\nresources(\"prefix_\")\n}\n}\n}\n</code></pre> <ul> <li>Update kotlin-cli-util to <code>2.0.0</code>.</li> <li>Update Moshi to <code>1.15.0</code>.</li> <li>Update sort-dependencies to <code>0.4</code>.</li> <li>Update KSP to <code>1.9.0-1.0.13</code>.</li> <li>Update Okio to <code>3.5.0</code>.</li> <li>Update Jetbrains Markdown to <code>0.5.0</code>.</li> </ul>"},{"location":"changelog/#0103","title":"0.10.3","text":"<p>2023-08-08</p> <ul> <li>Fix an issue with Skippy where we would accidentally mark all library projects as affected androidTest projects even if they didn\u2019t have androidTest enabled.</li> <li>Update Guava to <code>32.1.2-jre</code>.</li> </ul>"},{"location":"changelog/#0102","title":"0.10.2","text":"<p>2023-08-08</p> <ul> <li>Apparently the bugsnag plugin relies on the version code to be set in the variant output, so now we set a default again (configurable via <code>slack.gradle.defaultVersionCode</code>). The default is <code>90009999</code>, for reasons.</li> </ul>"},{"location":"changelog/#0101","title":"0.10.1","text":"<p>2023-08-07</p> <ul> <li>Use a single version code for all APK architectures.</li> <li>Before, we used to compute a different version code for each architecture. This is kinda silly, and broke with AGP 8.1.0. So now we no longer do this. This means that by default, no custom version code is set unless an override is set in <code>{rootProject}/build/ci/release.version</code>. The default behavior will be to just use the version set in the <code>android</code> DSL.</li> <li>Update to Detekt <code>1.23.1</code>.</li> <li>Update to Gradle Enterprise <code>3.14.1</code>.</li> <li>Update to Compose Multiplatform <code>1.4.3</code>.</li> <li>Update to SqlDelight <code>2.0.0</code>.</li> <li>Update to Anvil <code>2.4.7</code>.</li> </ul>"},{"location":"changelog/#0100","title":"0.10.0","text":"<p>2023-07-25</p> <ul> <li>Update to Kotlin <code>1.9.0</code>.</li> <li>Update to KSP <code>1.9.0-1.0.12</code>.</li> <li>Update to AGP <code>8.1.0</code>.</li> <li>Update kotlin-cli-util to <code>1.2.3</code>.</li> <li>Update MoshiX to <code>0.24.0</code>.</li> <li>Update redacted to <code>1.5.0</code>.</li> <li>Update wire to <code>4.8.0</code>.</li> <li>Add new dagger flag to ignore wildcard keys by default.</li> <li>https://dagger.dev/dev-guide/compiler-options#ignore-provision-key-wildcards</li> </ul>"},{"location":"changelog/#0918","title":"0.9.18","text":"<p>2023-07-12</p> <ul> <li>Fix: Differentiate unit and instrumentation tests in Skippy. Now changing a unit test will not cause the instrumentation tests to be marked as affected.</li> <li>Add <code>slack.dependencyrake.dryRun</code> gradle property flag for dependency rake to enable dry-run. If enabled, the project build files will not be modified and a separate <code>new-build.gradle.kts</code> file will be written to instead.</li> <li>Update Okio to <code>3.4.0</code>.</li> </ul>"},{"location":"changelog/#0917","title":"0.9.17","text":"<p>2023-07-07</p> <ul> <li>Don\u2019t register <code>RakeDependencies</code> task on platform projects.</li> <li>Fix configuration cache for Dependency Rake. Note that DAGP doesn\u2019t yet support it.</li> <li>Add Dependency Rake usage to its doc.</li> <li>Add missing identifiers aggregation for Dependency Rake. This makes it easier to find and add missing identifiers to version catalogs that dependency rake expects.</li> <li><code>./gradlew aggregateMissingIdentifiers -Pslack.gradle.config.enableAnalysisPlugin=true --no-configuration-cache</code></li> </ul>"},{"location":"changelog/#0916","title":"0.9.16","text":"<p>2023-06-30</p> <ul> <li>Enable lint on test sources by default.</li> <li>Account for all version catalogs in <code>DependencyRake</code>.</li> <li>Update Guava to <code>32.1.0-jre</code>.</li> </ul>"},{"location":"changelog/#0915","title":"0.9.15","text":"<p>2023-06-29</p> <ul> <li>Switch Robolectric jar downloads to use detached configurations.</li> <li>This lets Gradle do the heavy lifting of caching the downloaded jars and also allows downloading them from a configured repository setup. This also simplifies the up-to-date checks.</li> <li>Docs are now published on https://slackhq.github.io/slack-gradle-plugin. This is a work in progress.</li> <li>API kdocs are published at https://slackhq.github.io/slack-gradle-plugin/api/0.x/.</li> <li>Update <code>kotlin-cli-util</code> to 1.2.2.</li> </ul>"},{"location":"changelog/#0914","title":"0.9.14","text":"<p>2023-06-25</p> <ul> <li>Fix compose compiler config not applying to android projects.</li> </ul>"},{"location":"changelog/#0913","title":"0.9.13","text":"<p>2023-06-24</p> <ul> <li>Fix wrong map key name being used in exclusion.</li> </ul>"},{"location":"changelog/#0912","title":"0.9.12","text":"<p>2023-06-24</p> <ul> <li>Fix wrong dependency being used for compose-compiler in new Compose configuration overhaul.</li> </ul>"},{"location":"changelog/#0911","title":"0.9.11","text":"<p>2023-06-24</p> <ul> <li>Overhaul configuration of the Compose compiler across Android and multiplatform projects to make it easier to test the matrix of the AndroidX compose compiler, the JetBrains compose compiler, and new Kotlin versions.</li> <li>New: Add a <code>sgp.compose.multiplatform.forceAndroidXComposeCompiler</code> Gradle property flag to force use of the AndroidX compose compiler in Compose Multiplatform projects.</li> <li>New: Add a <code>sgp.config.jvmVendor.optOut</code> Gradle property flag to disable jvmVendor configuration in toolchains.</li> <li>Fix: No longer try to watch thermals on Intel macOS machines when configuration cache is enabled.</li> </ul>"},{"location":"changelog/#0910","title":"0.9.10","text":"<p>2023-06-06</p> <ul> <li>Fix: Don\u2019t apply vendor property to Bootstrap toolchain if it\u2019s undefined.</li> </ul>"},{"location":"changelog/#099","title":"0.9.9","text":"<p>2023-06-06</p> <ul> <li>New: Robolectric is now optional. Its support will only be enabled if there is a <code>robolectric</code> key in the primary version catalog.</li> <li>Enhancement: Update bootstrap JVM args to use ExitOnOutOfMemoryError for OOMs. No longer takes a heap dump on OOM.</li> <li>Enhancement: Update unit test verbose mode to use CrashOnOutOfMemoryError for OOMs to produce more logs.</li> <li>Fix: Bootstrap now respects the <code>sgp.config.jvmVendor</code> property.</li> <li>Build against Wire to <code>4.7.0</code>.</li> <li>Build against Anvil <code>2.4.6</code>.</li> <li>Build against AGP <code>8.0.2</code>.</li> <li>Build against Detekt <code>1.23.0</code>.</li> </ul>"},{"location":"changelog/#098","title":"0.9.8","text":"<p>2023-05-15</p> <ul> <li>Fix eager check of whether or not androidTest is enabled in <code>slack</code> DSL.</li> </ul>"},{"location":"changelog/#097","title":"0.9.7","text":"<p>2023-05-15</p> <ul> <li>Fix application targets not getting marked as androidTest()-enabled.</li> </ul>"},{"location":"changelog/#096","title":"0.9.6","text":"<p>2023-05-09</p> <ul> <li>Fix wrong use of <code>disallowChanges()</code> on <code>javaCompiler</code> in JavaCompile tasks. It seems that Gradle sets this multiple times.</li> <li>Improve git version matching.</li> </ul>"},{"location":"changelog/#095","title":"0.9.5","text":"<p>2023-05-09</p> <ul> <li>Use <code>disallowChanges()</code> where possible on properties SGP controls in order to avoid accidental overwrites.</li> <li>Make <code>ComputeAffectedProjectsTask</code> also generate a <code>affected_android_test_projects.txt</code> file with a newline-delimited list of affected projects that enable <code>androidTest()</code>. This can be used in CI scripts to statically determine if instrumentation tests need to run.</li> </ul>"},{"location":"changelog/#094","title":"0.9.4","text":"<p>2023-05-06</p> <ul> <li>Fix alias naming in <code>SlackVersions</code>. See <code>SlackVersions.kt</code> for updated expected naming of aliases.</li> </ul>"},{"location":"changelog/#093","title":"0.9.3","text":"<p>2023-05-05</p> <ul> <li>Add <code>jdk.compiler/com.sun.tools.javac.model</code> to Bootstrap Gradle JVM args and exec prefixes for binaries for GJF 17.</li> </ul>"},{"location":"changelog/#092","title":"0.9.2","text":"<p>2023-05-05</p> <ul> <li>Fix accidental noisy JVM vendor log.</li> </ul>"},{"location":"changelog/#091","title":"0.9.1","text":"<p>2023-05-04</p> <p>Happy May the Fourth!</p> <ul> <li>Add new <code>sgp.config.jvmVendor</code> property to control the JVM vendor used in Kotlin and Java toolchains. This value is used to match a known vendor spec, such as <code>AZUL</code>.</li> <li>Apply the kover plugin in an <code>afterEvaluate</code> block to avoid https://github.com/Kotlin/kotlinx-kover/issues/362.</li> <li>Update jgrapht to 1.5.2.</li> <li>Update oshi to 6.4.2.</li> </ul>"},{"location":"changelog/#090","title":"0.9.0","text":"<p>2023-04-30</p> <ul> <li>Improve Skippy logging.</li> <li>Configure all Kotlin compilations, not just JVM compilations.</li> <li>Split standard JVM args and common Kotlin args.</li> <li>Simplify <code>OkHttpClient</code> setup in <code>SlackTools</code>.</li> <li>Update to Kotlin 1.8.21.</li> <li>Support Dagger KSP in <code>slack.features.dagger</code> DSL controls. There are two new properties to control this:</li> <li><code>slack.ksp.allow-dagger</code> \u2013 allow use of Dagger in KSP.</li> <li><code>slack.ksp.allow-anvil</code> \u2013 allow use of Anvil in KSP. Note this is not yet implemented in Anvil, just a toe-hold for the future.</li> <li>Add debugging logs for loading <code>SlackToolsExtension</code> instances + fix classloader used for it.</li> <li>Gracefully handle <code>SlackToolsExtension</code> extensions that fail to load.</li> </ul>"},{"location":"changelog/#0810","title":"0.8.10","text":"<p>2023-04-25</p> <ul> <li>Add <code>Context</code> to <code>SlackToolsExtension</code>.</li> </ul>"},{"location":"changelog/#089","title":"0.8.9","text":"<p>2023-04-25</p> <ul> <li>Expose missing <code>SlackTools.findExtension</code> API.</li> <li>Expose missing <code>SlackTools.SERVICE_NAME</code> for <code>@ServiceReference</code> API.</li> </ul>"},{"location":"changelog/#088","title":"0.8.8","text":"<p>2023-04-25</p> <ul> <li>Update to Kotlin 1.8.20.</li> <li>Remove <code>moshi-kotlin</code>, only use generated adapters now.</li> <li>Don\u2019t auto-apply the Kover plugin on a platform project.</li> <li>Add new <code>sgp.ge.apply-common-build-tags</code> property flag to gate applying common build tags to a project.</li> <li>Switch <code>SlackToolsExtension</code> to work as a <code>ServiceLoader</code> instead.</li> </ul>"},{"location":"changelog/#087","title":"0.8.7","text":"<p>2023-04-23</p> <ul> <li>Remove lock file checking in <code>SlackTools</code> because this apparently invalidates configuration cache every time.</li> </ul>"},{"location":"changelog/#086","title":"0.8.6","text":"<p>2023-04-22</p> <ul> <li>Revert using native Kotlin lambdas instead of <code>class</code> for SAM conversions due to https://github.com/gradle/gradle/issues/24871.</li> </ul>"},{"location":"changelog/#085","title":"0.8.5","text":"<p>2023-04-22</p> <ul> <li>Clean up thermals logging setup in <code>SlackTools</code> and support enabling property at different scopes (local.properties, etc).</li> <li>Shut down thermals heartbeat executor when <code>SlackTools</code> is closed.</li> <li>Use native Kotlin lambdas instead of <code>class</code> for SAM conversions. The minimum supported Gradle version is now 8.1, which introduced support for this.</li> </ul>"},{"location":"changelog/#084","title":"0.8.4","text":"<p>2023-04-22</p> <ul> <li>Fix JSON serialization for thermals data.</li> </ul>"},{"location":"changelog/#083","title":"0.8.3","text":"<p>2023-04-22</p> <ul> <li>Don\u2019t accidentally create new <code>SlackTools</code> instances when reporting background data to Gradle Enterprise. These instances would be orphaned because this would happen after Gradle had closed all existing services, and create a memory leak.</li> <li>Use a lock file to track <code>SlackTools</code> instances.</li> <li>Use a single-threaded <code>Executor</code> for <code>SlackTools</code>\u2018 thermals heartbeat.</li> </ul>"},{"location":"changelog/#082","title":"0.8.2","text":"<p>2023-04-22</p> <ul> <li>Log a <code>Throwable</code> with multiple instances of <code>SlackTools</code> to help track origin points.</li> </ul>"},{"location":"changelog/#081","title":"0.8.1","text":"<p>2023-04-22</p> <ul> <li>Add some debug logging to <code>SlackTools</code> to track multiple instances.</li> </ul>"},{"location":"changelog/#080","title":"0.8.0","text":"<p>2023-04-15</p> <ul> <li>Fix: Wrap all exec operations in a <code>ValueSource</code> for Gradle 8.x compatibility.</li> <li>Fix: Set git line endings to <code>PLATFORM_NATIVE</code> in spotless by default. Its default of looking at <code>.gitattributes</code> is expensive and incompatible with Gradle 8.1+ configuration caching.</li> <li>Fix: Add <code>slack.auto-apply.sort-dependencies</code> boolean Gradle property to gate auto-applying the sort-dependencies plugin.</li> <li>SGP now requires AGP 8.0+ (and with it \u2013 Gradle 8+).</li> </ul>"},{"location":"changelog/#079","title":"0.7.9","text":"<p>2023-04-01</p> <p>Happy April Fool\u2019s Day!</p> <ul> <li>[Skippy] Recursively resolve project dependencies to avoid missing transitive edges in the graph. Previously we only computed shallow dependencies.</li> </ul>"},{"location":"changelog/#078","title":"0.7.8","text":"<p>2023-03-28</p> <ul> <li>Fix: Add missing <code>detekt</code> task dependencies for <code>globalDetekt</code>.</li> <li>Fix: Only apply detekt config once (even if multiple Kotlin plugins are applied).</li> </ul>"},{"location":"changelog/#077","title":"0.7.7","text":"<p>2023-03-27</p> <ul> <li>Add new <code>slack.detekt.full</code> property to gate whether or to run full detekt (i.e. with type resolution). If disabled, <code>detektRelease</code>/<code>detektMain</code> and associated tasks will be disabled and not used in <code>detektGlobal</code>.</li> </ul>"},{"location":"changelog/#076","title":"0.7.6","text":"<p>2023-03-25</p> <ul> <li>Fix: Apply matching configurations to <code>DetektCreateBaselineTask</code> tasks too due to https://github.com/detekt/detekt/issues/5940.</li> </ul>"},{"location":"changelog/#075","title":"0.7.5","text":"<p>2023-03-24</p> <ul> <li>[Skippy] Add more default configurations.</li> <li>[Skippy] Add <code>slack.avoidance.build-upon-default-affected-project-configurations</code> flag to make provided configurations build upon defaults.</li> <li>Add new <code>globalDetekt</code> task that runs <code>detekt</code> on all subprojects. This is Skippy-compatible and responds to <code>slack.avoidance.affectedProjectsFile</code>.</li> </ul>"},{"location":"changelog/#074","title":"0.7.4","text":"<p>2023-03-22</p> <ul> <li>Don\u2019t expose <code>androidExtension</code> publicly in <code>SlackExtension</code> to avoid Gradle mismatching number of type arguments in AGP 8.1.0-alpha10+.</li> </ul>"},{"location":"changelog/#073","title":"0.7.3","text":"<p>2023-03-22</p> <ul> <li>Set <code>Detekt.jdkHome</code> to null to avoid https://github.com/detekt/detekt/issues/5925.</li> <li>Rename <code>String.safeCapitalize()</code> to <code>String.capitalizeUS()</code> to make it more explicit.</li> </ul>"},{"location":"changelog/#072","title":"0.7.2","text":"<p>2023-03-21</p> <ul> <li>Disable Live Literals in Compose by default due to multiple issues. They can be enabled via <code>-Pslack.compose.android.enableLiveLiterals=true</code>.</li> <li>Poor runtime performance: https://issuetracker.google.com/issues/274207650.</li> <li>Non-deterministic class files breaking build cache: https://issuetracker.google.com/issues/274231394.</li> <li>[Skippy] Add <code>.github/actions/**</code> to default never skip filters.</li> </ul>"},{"location":"changelog/#071","title":"0.7.1","text":"<p>2023-03-20</p> <ul> <li>[Skippy] Improve pattern configuration.</li> <li>Make the default patterns public. This allows consumers to more      easily reuse them when customizing their own.</li> <li>Use sets for the type to better enforce uniqueness requirements.</li> <li>Add github actions to never-skip defaults.</li> <li>Add excludePatterns to allow finer-grained control. This runs after      include filtering so that users can manually exclude certain files that      may otherwise be captured in an inclusion filter and is difficult to      describe in a simple glob pattern. GitHub action does similar controls      for CI matrices.</li> <li>[Skippy] Allow relative (from the project root) to <code>affected_projects.txt</code> and allow non-existent files as a value. This makes it easy to gracefully fall back in CI.</li> <li>[Skippy] Fix logging path matchers missing toString() impls.</li> <li>[SKippy] Log verbosely in debug mode when skipping task deps.</li> <li>Update oshi to <code>6.4.1</code>.</li> </ul>"},{"location":"changelog/#070","title":"0.7.0","text":"<p>2023-03-17</p>"},{"location":"changelog/#project-skippy","title":"Project Skippy","text":"<p>This release introduces an experimental new <code>computeAffectedProjects</code> task for computing affected projects based on an input of changed files. The goal of this is to statically detect which unit test, lint, and androidTest checks can be safely skipped in CI on pull requests.</p> <p>Example usage <pre><code>./gradlew computeAffectedProjects --changed-files changed_files.txt\n</code></pre></p> <p>Where <code>changed_files.txt</code> is resolved against the root repo directory and contains a newline-delimited list of changed files (usually inferred from a PR).</p> <p>A simple example of how to produce such a file with the <code>gh</code> CLI:</p> <pre><code>gh pr view ${{ github.event.number }} --json files -q '.files[].path' &gt; changed_files.txt\n</code></pre> <p>One would run this task first as a preflight task, then run subsequent builds with the <code>slack.avoidance.affectedProjectsFile</code> Gradle property pointing to its output file location (printed at the end of the task).</p> <pre><code>./gradlew ... -Pslack.avoidance.affectedProjectsFile=/Users/zacsweers/dev/slack/slack-android-ng/build/skippy/affected_projects.txt\n</code></pre> <p>The <code>globalCiLint</code>, <code>globalCiUnitTest</code>, and <code>aggregateAndroidTestApks</code> tasks all support reading this property and will avoid adding dependencies on tasks in projects that are not present in this set.</p> <p>The <code>ComputeAffectedProjectsTask</code> task has some sensible defaults, but can be configured further in the root projects like so.</p> <pre><code>tasks.named&lt;ComputeAffectedProjectsTask&gt;(\"computeAffectedProjects\") {\n// Glob patterns of files to include in computing\nincludePatterns.addAll(\n\"**/*.kt\",\n\"**/*.java\",\n)\n// Glob patterns of files that, if changed, should result in not skipping anything in the build\nneverSkipPatterns.addAll(\n\"**/*.versions.toml\",\n\"gradle/wrapper/**\",\n)\n}\n</code></pre> <p>Debug logging can be enabled via the <code>slack.debug=true</code> Gradle property. This will output timings, logs, and diagnostics for the task.</p> <p>The configurations used to determine the build graph can be customized via comma-separated list to the <code>slack.avoidance.affected-project-configurations</code> property.</p>"},{"location":"changelog/#061","title":"0.6.1","text":"<p>2023-03-15</p> <p>Happy Ted Lasso season 3 premier day!</p> <ul> <li>Fix: Remove <code>UseContainerSupport</code> jvm arg from unit tests as this appears to only work on Linux.</li> </ul>"},{"location":"changelog/#060","title":"0.6.0","text":"<p>2023-03-14</p> <p>Happy Pi day!</p> <ul> <li>Refactor how unit tests are configured.</li> <li><code>Test</code> tasks are now configured more consistently across CI and local, so there should be more cache hits.</li> <li>Add a new <code>globalCiUnitTest</code> task to the root project to ease running <code>ciUnitTest</code> tasks across all subprojects.</li> <li>Add new properties to <code>SlackProperties</code> for controlling max parallelism and <code>forkEvery</code> options in <code>Test</code> tasks.</li> <li>Refactor how lint tasks are configured.</li> <li>Add a new <code>ciLint</code> task to every project that depends on all lint tasks in that project. This is intended to be the inverse     behavior of the built-in <code>lint</code> task in Android projects, which only runs the default variant\u2019s lint task.</li> <li>Add a new <code>globalCiLint</code> task to the root project to ease running <code>ciLint</code> tasks across all subprojects.</li> <li>Add new properties to <code>SlackProperties</code> for controlling which variants should be linted.</li> <li>Revert \u201cAdd lintErrorRuleIds property\u201d. <code>lint.xml</code> is the right place for this kind of logic.</li> </ul>"},{"location":"changelog/#0510","title":"0.5.10","text":"<p>2023-03-07</p> <ul> <li>Reduce noisy JNA load failures logging. Still have not gotten to the root cause, but at least this will reduce the log noise.</li> <li>Add a new <code>slack.lint.severity.errorRuleIds</code> Gradle property to specify lint rule IDs that should always be error severity.</li> </ul>"},{"location":"changelog/#059","title":"0.5.9","text":"<p>2023-02-27</p> <ul> <li>Gracefully handle JNA load failures in thermals logging.</li> </ul>"},{"location":"changelog/#058","title":"0.5.8","text":"<p>2023-02-20</p> <ul> <li>Enhancement: Remove kotlin-dsl from the plugin. If you were indirectly relying on its APIs from this plugin, you\u2019ll need to add that dependency separately.</li> <li>Enhancement: Better support fully modularized lints</li> <li><code>checkDependencies</code> is no longer enabled by default.</li> <li>Make the baseline file name configurable via <code>slack.lint.baseline-file-name</code> property. Defaults to <code>lint-baseline.xml</code>.</li> <li>Fix: <code>ImplicitSamInstance</code> lint not being enabled.</li> </ul>"},{"location":"changelog/#057","title":"0.5.7","text":"<p>2023-02-15</p> <ul> <li>Fix: <code>MergeFileTask.kt</code> was accidentally removed during a previous release.</li> <li>Fix: Add <code>jna-platform</code> dependency to align with the <code>jna</code> dependency version.</li> </ul>"},{"location":"changelog/#056","title":"0.5.6","text":"<p>2023-02-15</p> <p>Do not use! Release was accidentally messed up.</p>"},{"location":"changelog/#055","title":"0.5.5","text":"<p>2023-02-13</p> <ul> <li>Fix: <code>LocTask</code> is now compatible with Gradle 8.0 and has the correct task dependencies when Ksp, Kapt, etc are running.</li> <li>Fix: <code>LocTask</code> is now compatible with remote build cache.</li> <li>Enhancement: ModScore now supports KSP.</li> <li>Enhancement: Binary download tasks (<code>KtfmtDownloadTask</code>, <code>DetektDownloadTask</code>, etc) now have prettier and more reliable download progress indications.</li> <li>Enhancement: <code>UpdateRobolectricJarsTask</code> now uses Gradle workers to parallelize downloads. On gigabit wifi, this takes the task runtime down from ~21sec to ~13sec.</li> <li>Enhancement: The boolean <code>SLACK_FORCE_REDOWNLOAD_ROBOLECTRIC_JARS</code> env variable can be used to force <code>UpdateRobolectricJarsTask</code> to redownload jars even if already downloaded. Behavior change: Mod score must now be opted in to via the <code>slack.gradle.config.modscore.enabled=true</code> gradle property.</li> <li>Enhancement: Mod score can be disabled per-project via the <code>slack.gradle.config.modscore.ignore=true</code> gradle property.</li> </ul>"},{"location":"changelog/#054","title":"0.5.4","text":"<p>2023-02-07</p> <ul> <li>New: Integrate gradle-dependency-sorter as another formatter. This automatically apply if the <code>sortDependencies</code> toml version is present, and you can have it download+create executable binaries via <code>./gradlew downloadDependenciesSorter</code>.</li> <li>Enhancement: Improve compose multiplatform support. Now the <code>compose()</code> DSL is moved to <code>slack.features</code> and offers an optional <code>multiplatform</code> parameter to enable the compose multiplatform plugin.   <pre><code>slack {\nfeatures {\ncompose(multiplatform = &lt;true|false&gt;)\n}\n}\n</code></pre></li> <li>Build against Kotlin <code>1.8.10</code> and AGP <code>7.4.1</code>.</li> </ul>"},{"location":"changelog/#053","title":"0.5.3","text":"<p>2023-01-27</p> <ul> <li>Fix the <code>MergeFilesTask</code> monkeypatch using env vars instead of system props.</li> </ul>"},{"location":"changelog/#052","title":"0.5.2","text":"<p>2023-01-26</p> <ul> <li>Try another fix for the <code>MergeFilesTask</code> monkeypatch plus extra logging. Feel free to skip this update if you\u2019re unaffected.</li> </ul>"},{"location":"changelog/#051","title":"0.5.1","text":"<p>2023-01-23</p> <ul> <li>Fix: Unwrap <code>Optional</code> for <code>google-coreLibraryDesugaring</code> dependency before adding it. The Gradle API\u2019s lack of type safety strikes again.</li> </ul>"},{"location":"changelog/#050","title":"0.5.0","text":"<p>2023-01-23</p> <ul> <li>New: Introduce a new <code>sgp-monkeypatch-agp</code> artifact. This contains monkeypatches for AGP where we try to fix bugs. This initial version contains a patched <code>MergeFilesTask</code> that sorts files before merging them to ensure deterministic outputs, as we believe this is causing our lint tasks to be non-cacheable across machines. This can be enabled via setting the <code>com.slack.sgp.sort-merge-files</code> system property to <code>true</code>.</li> <li>New: Rework how bugsnag is enabled. Instead of only applying the plugin in release/main builds, we now always apply the plugin and only enable uploads on release/main builds. This allows us to catch issues with the plugin in updates sooner, as before we would not see them on PRs.</li> <li>Uploads can be force-enabled via setting the <code>slack.gradle.config.bugsnag.enabled</code> gradle property to true.</li> <li>Branches that allow uploads can be configured via regexp value on the <code>slack.gradle.config.bugsnag.enabledBranchPattern</code> gradle property. For example: <code>slack.gradle.config.bugsnag.enabledBranchPattern=main|release_.*</code>.</li> <li>New: Source desugar libraries from <code>libs.versions.toml</code> instead of assuming the artifact name. Starting with 1.2.0, desugar JDK libs offers multiple artifacts. Point <code>google-coreLibraryDesugaring</code> in [libraries] to whichever artifact should be used.</li> <li>Fix: Catch and print errors with thermal closes.</li> <li>Misc: Update to JDK 19 and latest AGPs. The plugin itself still targets JVM 11 bytecode. AGP 7.4.0 is now required.</li> </ul>"},{"location":"changelog/#042","title":"0.4.2","text":"<p>2023-01-13</p> <ul> <li>Enhancement: Change default gradle memory percent in bootstrap from 25% to 50%.</li> <li>Fix: Support the gradle enterprise plugin retry implementation when using Gradle enterprise 3.12+.</li> </ul>"},{"location":"changelog/#041","title":"0.4.1","text":"<p>2023-01-09</p> <p>Happy new year!</p> <ul> <li>Fix: Remove EitherNet compiler option opt-ins.</li> <li>Update Okio to <code>3.3.0</code>.</li> </ul>"},{"location":"changelog/#040","title":"0.4.0","text":"<p>2022-12-29</p> <ul> <li>Update to Kotlin 1.8.0. This plugin now requires Kotlin 1.8.0 or later as it only configures KGP\u2019s new <code>compilerOptions</code> API now.</li> </ul>"},{"location":"changelog/#038","title":"0.3.8","text":"<p>2022-12-22</p> <ul> <li>Add support for AGP 8.0.0-alpha10.</li> </ul>"},{"location":"changelog/#037","title":"0.3.7","text":"<p>2022-12-19</p> <ul> <li>Fix: Don\u2019t apply freeCompilerArguments.</li> <li>Fix: Add missing license information to published POM files.</li> </ul>"},{"location":"changelog/#036","title":"0.3.6","text":"<p>2022-12-15</p> <ul> <li>Backport <code>android.packagingOptions.jniLibs.pickFirst</code> for AGP 8.x compatibility, as the returned type by <code>jniLibs</code> changed from <code>JniLibsPackagingOptions</code> to <code>JniLibsPackaging</code>.</li> </ul>"},{"location":"changelog/#035","title":"0.3.5","text":"<p>2022-12-06</p> <ul> <li>Introduce <code>compileCiUnitTest</code> lifecycle task to just compile (but not run!) unit tests that are run by <code>ciUnitTest</code>.</li> </ul>"},{"location":"changelog/#034","title":"0.3.4","text":"<p>2022-12-04</p> <ul> <li>Only enable <code>isIncludeAndroidResources</code> in Android unit tests automatically when <code>robolectric()</code> is used.</li> </ul>"},{"location":"changelog/#033","title":"0.3.3","text":"<p>2022-11-11</p> <ul> <li>Add some more Kotlin compiler arguments to compilations. See #160</li> </ul>"},{"location":"changelog/#032","title":"0.3.2","text":"<p>2022-11-10</p> <ul> <li>(Strict mode only) Check for <code>AndroidManifest.xml</code> files in androidTest sources + ensure they\u2019re debuggable.</li> </ul>"},{"location":"changelog/#031","title":"0.3.1","text":"<p>2022-10-20</p> <ul> <li>Exclude <code>**/build/**</code> from <code>Detekt</code> tasks.</li> </ul>"},{"location":"changelog/#030","title":"0.3.0","text":"<p>2022-10-14</p> <ul> <li>New: Support <code>com.android.test</code> projects.</li> <li>New: Preliminary support for AGP 8.x.</li> <li>Automatically add compose compiler dep in Compose multiplatform (i.e. <code>org.jetbrains.compose</code>) projects.</li> <li>Support Error Prone Gradle Plugin 3.x.</li> <li>Update <code>me.tongfei:progressbar</code> to <code>0.9.5</code>.</li> </ul>"},{"location":"changelog/#024","title":"0.2.4","text":"<p>2022-10-06</p> <ul> <li>Fix: Only check allowed androidTest variants if any are defined.</li> </ul>"},{"location":"changelog/#023","title":"0.2.3","text":"<p>2022-10-03</p> <ul> <li>Fix: Only configure bootstrap conditionally.</li> </ul>"},{"location":"changelog/#022","title":"0.2.2","text":"<p>2022-10-03</p> <ul> <li>Add necessary <code>--add-opens</code> to <code>Test</code> tasks for Robolectric 4.9+ when it\u2019s enabled.</li> <li>Avoid <code>subprojects</code> module stats and <code>allprojects</code> in bootstrap for better project isolation support.</li> </ul>"},{"location":"changelog/#021","title":"0.2.1","text":"<p>2022-09-27</p> <ul> <li>Fix: New <code>androidTest(allowedVariants = ...)</code> wasn\u2019t running on <code>com.android.application</code> projects.</li> <li>Fix: Configure <code>Lint</code> DSL block for <code>com.android.library</code> and <code>org.jetbrains.kotlin.jvm</code> projects too.</li> </ul>"},{"location":"changelog/#020","title":"0.2.0","text":"<p>2022-09-23</p> <ul> <li>Add option to enable only certain variants\u2019 android tests.</li> </ul> <pre><code>slack {\nandroid {\nfeatures {\nandroidTest(allowedVariants = setOf(\"internalDebug\"))\n}\n}\n}\n</code></pre>"},{"location":"changelog/#012","title":"0.1.2","text":"<p>2022-09-20</p> <ul> <li>Support Robolectric jars for Android API 30.</li> </ul>"},{"location":"changelog/#011","title":"0.1.1","text":"<p>2022-09-08</p> <ul> <li>Fix wrong <code>slack.unit-test</code> plugin application.</li> </ul>"},{"location":"changelog/#010","title":"0.1.0","text":"<p>2022-09-07</p> <ul> <li>Update to Moshi 1.14.0.</li> <li>Disable <code>Instantiatable</code> lint in min SDK 28+ due to lint bug.</li> <li>Specify kotlin version in compose compatibility check.</li> </ul>"},{"location":"code-of-conduct/","title":"Code of Conduct","text":""},{"location":"code-of-conduct/#introduction","title":"Introduction","text":"<p>Diversity and inclusion make our community strong. We encourage participation from the most varied and diverse backgrounds possible and want to be very clear about where we stand.</p> <p>Our goal is to maintain a safe, helpful and friendly community for everyone, regardless of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other defining characteristic.</p> <p>This code and related procedures also apply to unacceptable behavior occurring outside the scope of community activities, in all community venues (online and in-person) as well as in all one-on-one communications, and anywhere such behavior has the potential to adversely affect the safety and well-being of community members.</p> <p>For more information on our code of conduct, please visit https://slackhq.github.io/code-of-conduct</p>"},{"location":"configuration/","title":"Configuration","text":"<p>TODO</p>"},{"location":"contributing/","title":"Contributors Guide","text":"<p>Note that this project is considered READ-ONLY. You are welcome to discuss or ask questions in the discussions section of the repo, but we do not normally accept external contributions without prior discussion.</p>"},{"location":"contributing/#development","title":"Development","text":"<p>Check out this repo with Android Studio or IntelliJ. It\u2019s a standard gradle project and conventional to check out.</p> <p>The primary project is <code>slack-plugin</code>.</p> <p>Kotlin should be used for more idiomatic use with Gradle/AGP APIs</p> <p>Code formatting is checked via Spotless. To run the formatter, use the <code>spotlessApply</code> command.</p> <pre><code>./gradlew spotlessApply\n</code></pre> <p>Optionally, there are commit hooks in the repo you can enable by running the below <pre><code>git config core.hooksPath config/git/hooks\n</code></pre></p>"},{"location":"dependency-rake/","title":"Dependency Rake","text":"<p>Dependency rake is an tool we develop within slack-gradle-plugin (SGP) to automatically clean up Gradle build files.</p> <p>This tool uses the outputs of the dependency-analysis-gradle-plugin ( DAGP) to infer and apply fixes it recommends.</p>"},{"location":"dependency-rake/#types-of-fixes","title":"Types of Fixes","text":"<p>There are three main categories of fixes that DR applies.</p> <ol> <li>Remove unused dependencies.<ul> <li>Like it says on the tin, these are declared dependencies that are unused and should be removed.</li> </ul> </li> <li>Fix misused dependencies.<ul> <li>These are dependencies that are declared but only transitive dependencies they include are actually used. For   example - depending on RxAndroid but only using RxJava from it. These are fixed by replacing the dependency with   the specific transitive dependency.</li> </ul> </li> <li>Fix wrong configurations.<ul> <li>These are dependencies that declare the wrong Gradle configuration (e.g. api, implementation, etc). Dependencies   determined to be used in the \u201cpublic ABI\u201d of the library should be \u201capi\u201d configuration for use in dependent   projects. Anything else can be hidden as an \u201cimplementation\u201d or \u201ccompileOnly\u201d (if annotations-only) dependency.</li> </ul> </li> </ol>"},{"location":"dependency-rake/#benefits","title":"Benefits","text":"<p>The primary benefit of dependency rake is to improve build times by more or less \u201craking\u201d the build dependency graph. By removing and fixing dependencies, we remove unneeded edges in the build graph. This in turn provides improved build parallelism and better avoidance in Skippy CI pipelines.</p> <p>A secondary benefit is automatic upkeep of build files. As projects change over time, dependencies become obsolete and out of date. Most developers do not keep up with these changes over time, so automating this affords us extra upkeep that we currently do not do.</p>"},{"location":"dependency-rake/#implementation","title":"Implementation","text":"<p>The core implementation of DR lives in <code>DependencyRake.kt</code>.</p>"},{"location":"dependency-rake/#usage","title":"Usage","text":"<p>To run dependency rake in a project, use the below command</p> <pre><code>$ ./gradlew rakeDependencies -Pslack.gradle.config.enableAnalysisPlugin=true --no-configuration-cache\n</code></pre> <p>This will run all <code>rakeDependencies</code> tasks in the project. This task exists on all subprojects as well, but it  works best if all are run together.</p> <p>Sometimes dependency rake will try to replace identifiers with ones that are not present in any available version catalogs. Sometimes this is acceptable, but often times it can result in \u201cmissing\u201d dependencies from  the build after it runs. To help fix these, DR will write all missing identifiers out to a build output file.</p> <p>For convenience, you can also run <code>./gradlew aggregateMissingIdentifiers -Pslack.gradle.config.enableAnalysisPlugin=true --no-configuration-cache</code> to run all dependency rake tasks and aggregate these missing identifiers into a root project build output file.</p>"},{"location":"dsl/","title":"DSL","text":"<p>SGP offers a DSL extension for configuring project behavior via the plugin. The idea is that developers don\u2019t really want to think about specific dependency wirings, and instead want to express what features they want and allow SGP to automatically wire these up for them.</p> <p>Some examples of this include Dagger, Moshi code gen, Robolectric, and more.</p> <p>The primary entry point is the <code>slack</code> extension in the build file, which is backed by the <code>SlackExtension</code> interface.</p> <pre><code>slack {\nfeatures {\ndagger(...)\nmoshi(...)\n}\nandroid {\nfeatures {\nrobolectric(...)\n}\n}\n}\n</code></pre>"},{"location":"dsl/#features","title":"Features","text":""},{"location":"dsl/#dagger","title":"Dagger","text":"<p>The Dagger feature automatically sets up both Dagger and Anvil. This includes optional parameters to control whether or not you want the runtime only, component merging, or other features. This automatically handles applying the Anvil, kapt, or KSP plugins under the hood and any necessary dependencies to run them.</p> <p>The default <code>dagger()</code> call will just enable Dagger\u2019s runtime + Anvil\u2019s factory generation with no component merging ( to avoid the Kapt cost).</p>"},{"location":"dsl/#moshi","title":"Moshi","text":"<p>The Moshi feature handles setting up both Moshi and MoshiX. This includes handling applying code gen logic (either KSP or IR) as well as <code>moshi-sealed</code> support if requested.</p>"},{"location":"dsl/#redacted","title":"Redacted","text":"<p>This enables the redacted-compiler-plugin compiler plugin.</p>"},{"location":"dsl/#compose","title":"Compose","text":"<p>The Compose feature handles setting up Compose in both Android and multiplatform projects. This handles a bunch of boilerplate (see <code>ComposeUtil.kt</code>) for applying the right compose-compiler artifact version as well as enabling the right controls in the Android plugin.</p>"},{"location":"dsl/#android-features","title":"Android Features","text":""},{"location":"dsl/#robolectric","title":"Robolectric","text":"<p>The Robolectric feature handles setting up Robolectric in an Android project. This entails common Robolectric dependencies (including any bundles or core Robolectric project dependencies). This also sets up Robolectric jar downloads (via <code>UpdateRobolectricJarsTask</code>) for test tasks and enabling resource merging in tests (which Robolectric requires). There are a few other controls that <code>StandardProjectConfigurations</code> use to control or patch Robolectric\u2019s behavior.</p>"},{"location":"dsl/#android-test","title":"Android Test","text":"<p>By default, SGP disables androidTests in projects. These can be enabled via the <code>androidTest()</code> feature, which will enable the relevant controls in the Android plugin. This can also accept specified variants to enable/disable.</p> <p>This is important for opting in tests to AndroidTest APK Aggregation.</p>"},{"location":"dsl/#resources","title":"Resources","text":"<p>By default, we disable Android resources (different from Java resources) and libraries have to opt-in to using them.</p> <p>This can be enabled via the <code>resources()</code> feature, which will enable the relevant <code>BuildFeature</code> in the Android plugin and also takes a required <code>prefix</code> parameter that is used as the required <code>resourcePrefix</code> for that library\u2019s resources to avoid naming conflicts.</p>"},{"location":"dsl/#android-application-features","title":"Android Application Features","text":""},{"location":"dsl/#permission-allowlist","title":"Permission AllowList","text":"<p>This enables checking of a permission allowlist. See <code>PermissionChecks</code> for more details.</p>"},{"location":"formatters-and-analysis/","title":"Formatters and Static Analysis","text":"<p>SGP supports running a number of formatters and static analysis tools.</p> <p>Individual tools are usually gated on whether they have a version specified in <code>libs.versions.toml</code>. If they do not have a version specified, they are deemed not enabled.</p>"},{"location":"formatters-and-analysis/#formatting","title":"Formatting","text":"<p>The core set of formatters are:</p> <ul> <li>ktfmt (Kotlin)</li> <li>google-java-format (Java)</li> <li>gson (JSON)</li> <li>gradle-dependency-sorter (Gradle build file dependencies)</li> <li>Spotless (general purpose Gradle plugin that runs most of the above)</li> </ul>"},{"location":"formatters-and-analysis/#static-analysis","title":"Static Analysis","text":"<p>The core set of analysis tools supported in SGP are:</p> <ul> <li>Android Lint (Kotlin, Java, XML resources, build files, etc.)</li> <li>Detekt (Kotlin)</li> <li>Error Prone (Java)</li> </ul>"},{"location":"formatters-and-analysis/#git-hooks","title":"Git Hooks","text":"<p>SGP ships with a standard set of git hooks (pre-commit, etc) that it can bootstrap in projects by running <code>./gradlew installCommitHooks</code>. These hooks rely on checking in relevant binaries for each formatter/checker, it\u2019s strongly recommended to use git-lfs for these. These files should be edited as needed to best serve the project they\u2019re running in.</p> <p>SGP can configure these hooks in the project automatically during bootstrap if you add the <code>slack.git.hooksPath</code> gradle property and point it at the hooks directory that the above command output to, or wherever the host project opts to store them.</p> <p>Note that Detekt is not yet supported in git hooks as these require extra parameters for baselines.</p>"},{"location":"formatters-and-analysis/#downloading-binaries","title":"Downloading binaries","text":"<p>Each tool (ktfmt, gjf, etc) has corresponding <code>./gradlew update&lt;tool name&gt;</code> tasks that you can run to download and install them, by default to <code>config/bin/&lt;tool name&gt;</code>. You should re-run these any time you update a tool to re-run them.</p>"},{"location":"lint/","title":"Lint","text":"<p>TODO</p>"},{"location":"mod-score/","title":"Mod Score","text":"<p>TODO</p>"},{"location":"properties/","title":"Properties","text":"<p>TODO</p>"},{"location":"skippy/","title":"Skippy","text":"<p>TODO</p>"},{"location":"testing/","title":"Testing","text":"<p>TODO</p>"},{"location":"thermals-logging/","title":"Thermals Logging","text":"<p>TODO</p>"},{"location":"utilities/","title":"Utilities","text":"<p>There are a bunch of miscellaneous utilities and tools in this project that don\u2019t necessarily warrant their own dedicated docs page.</p>"},{"location":"utilities/#androidsourcesconfigurer","title":"<code>AndroidSourcesConfigurer</code>","text":"<p>When testing new Android SDK betas, the compile SDK version is available months before sources are. Developers want to build against these APIs, but we don\u2019t want to make their experience in the IDE worse than necessary. The problem with using a compile SDK version that doesn\u2019t have sources is that the IDE can\u2019t provide any documentation for the APIs and will just show stub files instead.</p> <p>To work mitigate this, we will patch the SDK by putting a copy of the previous version\u2019s sources in the location of the new SDK. This allows most sources to still index properly during the beta period. Then, once the new sources are available, the consuming repo needs only to update the <code>slack.latestCompileSdkWithSources</code> gradle property to that new SDK version and the patcher will clear out that copy and let AGP download the real ones.</p> <p>This runs automatically in the root plugin.</p>"},{"location":"utilities/#androidtest-apk-aggregation","title":"AndroidTest APK Aggregation","text":"<p>At Slack we use FTL + Fladle for running our instrumentation tests. In order to add more test APKs from modularized instrumentation tests in other subprojects, we have to aggregate a list of their locations and pass them on to Fladle. This is done via <code>AndroidTestApksTask</code>, which is registered in the root project and can be wired to pipe its output file into Fladle\u2019s config input.</p> <p>Example</p> <pre><code>val aggregatedApksProvider = rootProject.tasks\n.named&lt;AndroidTestApksTask&gt;(\"aggregateAndroidTestApks\")\n.flatMap { it.outputFile }\n.map { it.asFile.readLines() }\n\ntasks\n.withType&lt;YamlConfigWriterTask&gt;()\n.matching { it.name == \"writeConfigProps${fladleTarget}\" }\n.configureEach { additionalTestApks.value(testInputsProvider) }\n</code></pre> <p>This task is automatically added to whenever a subproject uses the <code>androidTest()</code> DSL feature.</p>"},{"location":"utilities/#permissionchecks","title":"<code>PermissionChecks</code>","text":"<p>Permissions are an integral part of Android apps, and oversight into what permissions are required in the app is critical to a release pipeline. <code>PermissionChecks</code> is a feature to help with this.</p> <p>The workflow we use at Slack is like this:</p> <ul> <li>We check in a <code>permissionsAllowlist.txt</code> file in the Slack android repo.</li> <li>This file is owned in GitHub by a specific codeowner rule that adds a permission reviewers group.</li> <li>This file is passed into the <code>allowListFile</code> DSL feature in the application   project.</li> <li>On each build, SGP automatically checks that the permissions present in the release APK manifest match the ones   defined in the allowlist.</li> </ul> <p>This way new permissions are not accidentally or secretly added to the app.</p>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"slack-gradle-plugin","text":"<p>This repository contains the core Gradle plugin and associated logic used for Slack\u2019s Android app.</p> <p>This repo is effectively read-only and does not publish artifacts to Maven Central. We develop these in the open to knowledge-share with the community.</p> <p>As such, our issue tracker is closed and we don\u2019t normally accept external PRs, but we welcome your questions in the discussions section of the project!</p> <p>We may later publish some of these components. If you\u2019re interested in this, feel free to raise in a discussions post or vote for existing suggestions.</p>"},{"location":"#highlights","title":"Highlights","text":""},{"location":"#common-project-configuration","title":"Common project configuration","text":"<p>The <code>slack.base</code> plugin offers common configuration for all projects implementing it, covering a wide spectrum of Android, Kotlin, and Java configurations.</p> <p>This includes a whole host of things! - Common Android configuration (single variant libraries, disabling unused features, compose, etc). - Common Kotlin configuration (freeCompilerArgs, JVM target, etc). - Common Java configuration (toolchains, release versions, etc). - Common annotation processors. - SlackExtension (see next section). - Formatting (via Spotless). - Platforms and BOM dependencies (see \u201cPlatform plugins\u201d section below). - Common lint checks (both on Android and plain JVM projects).</p> <p>Full docs can be found in the architecture docs.</p>"},{"location":"#feature-dsl","title":"Feature DSL","text":"<p>To ease use and configuration of common features in projects, we expose a <code>slack</code> DSL in projects that allows for configuration of these in a semantically easy and boilerplate-free way. This is controlled via <code>SlackExtension</code>.</p> <pre><code>slack {\nfeatures {\ndagger()\nmoshi(codegen = true)\n}\nandroid {\nfeatures {\nrobolectric()\n}\n}\n}\n</code></pre> <p>A major benefit of this is that we can intelligently configure features and avoid applying costly plugins like Kapt unless they\u2019re actually needed for a specific feature, such as Java injections in projects using Dagger. Since this is pure code, we can also propagate deprecated behavior by deprecating the corresponding functions in the DSL.</p>"},{"location":"#platform-plugins","title":"Platform plugins","text":"<p><code>Platforms.kt</code> contains an implementation that sources a <code>VersionCatalog</code> and applies it to a Gradle platform project. This allows us to effectively treat our versions catalog as a BOM and apply it to all projects in the consuming repo and reduce dependency version stratification.</p>"},{"location":"#thermal-throttling-capture","title":"Thermal throttling capture","text":"<p>MacBooks can suffer thermal throttling and result in poor build performance. We built instrumentation for this to capture these and include them in our build scans to better understand their impact. We support both Intel and Apple Silicon macs now and contain this implementation in <code>ThermalsWatcher.kt</code>. This also includes helpful charting APIs for visualizing the data (courtesy of our friends at Square).</p>"},{"location":"#better-properties","title":"Better Properties","text":"<p>Gradle\u2019s built-in property support is limited and has surprising behavior, so we have our own system on top of it that has consistent precedence, <code>local.properties</code> support, project-local <code>gradle.properties</code>, and configuration caching support. Check out <code>safeProperty()</code> in <code>PropertyUtil.kt</code>.</p>"},{"location":"#dependency-rake","title":"Dependency Rake","text":"<p><code>DependencyRake.kt</code> contains an extension to the <code>gradle-dependency-analysis-plugin</code> that applies its advice to a project to automatically optimize it and rake dependencies.</p>"},{"location":"#module-stats-aka-mod-score","title":"Module Stats (aka \u201cMod Score\u201d)","text":"<p>As a part of our modularization efforts, we developed a scoring mechanism for modules that we could use as a measure of their \u201cmodularization\u201d. This includes a number of metrics and weighs them in a formula to compute a score. This includes LoC, language mixtures, and build graph centrality. This logic is under the <code>slack.stats</code> package.</p>"},{"location":"#robolectric-jars-management","title":"Robolectric Jars Management","text":"<p>Robolectric uses preinstrumented Android API jars that live on maven central. While it can handle downloading of these automatically, we found this implementation to be brittle and unreliable, so we built our own version of it that handles downloading these into a local <code>.cache</code> directory. This implementation lives in <code>UpdateRobolectricJarsTask.kt</code> and that task is configured to be a dependency of all <code>Test</code> tasks.</p>"},{"location":"#bootstrap","title":"Bootstrap","text":"<p>We try to simplify and streamline the bootstrap process for both local development and on CI. This involves computing optimized JVM arguments for the Gradle and Kotlin daemons (which differ between CI and local) as well as toe-holds for future customizations. This logic lives in <code>BootstrapTask.kt</code>.</p>"},{"location":"#permission-checks","title":"Permission Checks","text":"<p>To avoid accidentally checking in any new, unexpected manifest permissions, we have a <code>CheckManifestPermissionsTask</code> that compares the final merged manifest\u2019s permissions to an allow list of known permissions. This is allow list is checked in and expected to be guarded by a <code>CODEOWNERS</code> watch and will fail the build if they differ.</p> <pre><code>slack {\nandroid {\napp {\npermissionAllowlist {\nif (name == \"externalRelease\") {\nsetAllowlistFile(file(\"permissionsAllowlist.txt\"))\n}\n}\n}\n}\n}\n</code></pre>"},{"location":"#apk-versioning-computers","title":"APK Versioning Computers","text":"<p>AGP offers new property-based APIs for computing APK version codes and version names. We use this to compute information from different inputs (CI build number, git state, etc) and control this logic in <code>ApkVersioningPlugin.kt</code>.</p>"},{"location":"#check-dependency-versions","title":"Check dependency versions","text":"<p>Sometimes a dependency update may bring with it a surprise update to a transitive dependency that we also declare. In order to avoid this happening unexpectedly, the <code>CheckDependencyVersionsTask</code> checks that any transitive dependency versions that also correspond to a version declared in our <code>VersionCatalog</code> match the version there. It\u2019s ok if they don\u2019t, but the author just need to update the version in the catalog too to be explicit (or investigate further if it\u2019s an unwanted surprise!).</p>"},{"location":"#agp-handlers","title":"AGP Handlers","text":"<p>AGP occasionally contains new or breaking API changes that we want to handle gracefully in early testing. We regularly test against newer preview versions of AGP so we can\u2019t just hardcode in new APIs and expect them to work everywhere. To handle this, we have an <code>AgpHandler</code> interface that can be used to abstract these new APIs in a backward-compatible way. Then we ship implementations of this as different artifacts that are built against different AGP versions. Then, at runtime, we pick the appropriate instance (via service loading) to use for the current AGP version being used in that build.</p>"},{"location":"#detekt-baselining","title":"Detekt baselining","text":"<p>Detekt is a static analysis tool that we use to check for common issues in our code. We use one global baseline file for baselined issues (when introducing new checks or updates), but Detekt doesn\u2019t currently support this easily. So, we built <code>MergeDetektBaselinesTask</code> to merge all the generated baselines from each subproject into a single global baseline.</p>"},{"location":"#misc-tools","title":"Misc tools","text":"<p>There are a ton of miscellaneous tools, utilities, and glue code for Gradle (and various plugins) sprinkled throughout this project.</p>"},{"location":"#usage-requirements","title":"Usage requirements","text":"<p>SGP expects there to be a <code>libs</code> version catalog.</p> <p>The following versions are required to be set the above catalog. Their docs can be found in <code>SlackVersions.kt</code>. - <code>jdk</code></p> <p>For Android projects, some extra definitions need to be defined - <code>libs.versions.toml</code> libraries     - <code>google-coreLibraryDesugaring</code> - the core library desugaring libraries to use with L8. - <code>gradle.properties</code> properties     - <code>slack.compileSdkVersion</code>     - <code>slack.targetSdkVersion</code>     - <code>slack.minSdkVersion</code></p> <p>The following plugins are applied by default but can be disabled if you don\u2019t need them. - Gradle\u2019s test retry \u2013 <code>slack.auto-apply.test-retry</code>     - By default, this uses the Gradle test-retry plugin, but can be configured to use the Gradle Enterprise plugin\u2019s implementation instead by setting the <code>slack.test.retry.pluginType</code> property to <code>GE</code>. - Spotless \u2013 <code>slack.auto-apply.spotless</code> - Detekt \u2013 <code>slack.auto-apply.detekt</code> - NullAway \u2013 <code>slack.auto-apply.nullaway</code> - Android Cache Fix \u2013 <code>slack.auto-apply.cache-fix</code></p>"},{"location":"#commit-hooks","title":"Commit hooks","text":"<p>The <code>installCommitHooks</code> task can install commit hooks for formatting kotlin and java files. They expect binaries to be in <code>&lt;root&gt;/config/git/hooks</code> and it\u2019s highly recommended to enable git-lfs for these objects. These binaries can be downloaded via the <code>updateKtfmt</code>, <code>updateGjf</code>, etc tasks.</p>"},{"location":"#license","title":"License","text":"<pre><code>Copyright 2022 Slack Technologies, LLC\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n</code></pre>"},{"location":"architecture/","title":"Architecture","text":"<p>SGP consists of three Gradle plugins and some associated helper artifacts.</p>"},{"location":"architecture/#slackrootplugin","title":"<code>SlackRootPlugin</code>","text":"<p>This is the root plugin that is applied to the root project of a multi-project build.</p> <pre><code>plugins {\nid(\"com.slack.gradle.root\")\n}\n</code></pre> <p>Its responsibilities include:</p> <ul> <li>Registering the <code>SlackTools</code> build service.</li> <li>Setting up global configuration (i.e. global lifecycle tasks, download tasks, etc).</li> <li>Validating the JDK matches the expected JDK defined in <code>libs.versions.toml</code>.</li> <li>Configure git (hooks, ignored revisions, etc).</li> <li>(If running on macOS) Validating the build isn\u2019t running in Rosetta mode.</li> </ul>"},{"location":"architecture/#slackbaseplugin","title":"<code>SlackBasePlugin</code>","text":"<p>This is the base plugin that is applied to all projects (including the root project).</p> <pre><code>plugins {\nid(\"com.slack.gradle.base\")\n}\n</code></pre> <p>Its responsibilities include:</p> <ul> <li>Configuring formatters for Spotless.</li> <li>Configuring the buildscript and dependency classpaths. This includes \u201cfixing\u201d any known bad dependencies (Hamcrest and CheckerFramework are a mess), failing on non-reproducible dependency declarations.</li> <li>Running standard subproject configurations via <code>StandardProjectConfigurations</code>.</li> <li>Configuring unit tests via <code>UnitTests</code>. This also includes configuring the Gradle test retry plugin, if enabled.</li> <li>Configuring NullAway, if enabled.</li> <li>Configuring Skippy.</li> <li>Configuring Mod Score tasks.</li> </ul>"},{"location":"architecture/#standardprojectconfigurations","title":"<code>StandardProjectConfigurations</code>","text":"<p>This class warrants special mention as it is responsible for the bulk of the configuration applied to projects SGP manages.</p> <ul> <li>Creates and exposes the <code>slack</code> extension DSL.</li> <li>Applies common configurations.</li> <li>This largely just sets up the dependency sorter plugin.</li> <li>Applies common JVM configurations.</li> <li>Applies common Kotlin configurations.</li> </ul>"},{"location":"architecture/#jvm-configurations","title":"JVM Configurations","text":"<p>All JVM projects (Android, Java, Kotlin) receive some common configuration for their JVM tasks.</p>"},{"location":"architecture/#common","title":"Common","text":"<ul> <li>Applies the repo\u2019s platform project, if any.</li> <li>Applies any BOM dependencies to platform-configurable configurations.</li> <li>Configures the dependency analysis gradle plugin and <code>DependencyRake</code>.</li> <li>Applies common annotations and common test bundles from version catalogs.</li> <li>Fails on non-androidx support library dependencies.</li> <li>Configure common annotations processors.</li> <li>This logic is largely in <code>StandardProjectConfigurations.configureAnnotationProcessors()</code> and <code>StandardProjectConfigurations.APT_OPTION_CONFIGS</code>, which seeks to apply common configs for known processors like Dagger and Moshi.</li> </ul>"},{"location":"architecture/#java","title":"Java","text":"<p>Java projects are fairly simple. Note that these are applied on all projects that apply the <code>java</code> plugin, which is most of them!</p> <ul> <li>They are just configured to ensure their source/target compatibility is set to the repo\u2019s JVM target.</li> <li>In non-android projects, <code>JavaCompile</code> tasks have their <code>options.release</code> property set to this as well.</li> <li>Gradle toolchains are used to manage the JDK used for <code>JavaCompile</code> tasks in non-android projects to ensure consistency.</li> <li>All <code>JavaCompile</code> tasks have <code>-parameters</code> added to <code>options.compilerArgs</code> for better static analysis and annotation processing support.</li> <li>If opted-in, error-prone and nullaway are applied and set up with the project with common configurations (configured checks, ignoring build dirs, etc).</li> <li>SGP supports Error-Prone\u2019s auto-patching mode via enabling the <code>slack.epAutoPatch</code> property.</li> </ul>"},{"location":"architecture/#android","title":"Android","text":"<ul> <li>Configures AndroidTest APK aggregation with Skippy support.</li> <li>Applies the Android cache fix plugin, if enabled.</li> <li>Configures common AGP extensions (both legacy extensions and new Component extensions).</li> <li>Disables unused/irrelevant variants. SGP is single-variant for library projects by default.</li> <li>Disables android tests on projects unless opted in.</li> <li>Disables unit tests on app projects by default (we use the app project as just a shell project for producing an APK).</li> <li>Configures <code>compileOptions</code>, <code>defaultConfig</code>, compileSdk/targetSdk/minSdk/ndkVersion, etc.<ul> <li>Enables <code>vectorDrawables.useSupportLibrary</code>.</li> </ul> </li> <li>Enables core library desugaring.</li> <li>Configures common <code>testOptions</code> like orchestrator, <code>unitTests</code>, etc.<ul> <li><code>unitTests.isReturnDefaultValues</code> is always enabled for convenience.</li> <li><code>unitTests.isIncludeAndroidResources</code> is only enabled if robolectric is enabled on the project, as this is expensive to enable.</li> <li>Set up unit test <code>Test</code> tasks to depend on the <code>UpdateRobolectricJarsTask</code> if robolectric is enabled.</li> </ul> </li> <li>Patches objenesis dependency versions due to weird transitive dependencies in android test classpaths.</li> <li>Configures <code>com.android.library</code> and <code>com.android.application</code> projects. <code>com.android.test</code> is supported but somewhat limited.</li> <li>Application projects\u2026</li> <li>have their packaging config set up with some convenience common exclusions and handling common <code>jniLibs</code> handling.</li> <li>have v3 and v4 signing enabled by default.</li> <li>are configured with <code>PermissionChecks</code>.</li> <li>are configured with the Bugsnag gradle plugin, if enabled.</li> <li>Library projects\u2026</li> <li>are configured with an automatic <code>android.namespace</code>, if none is manually specified in the buildscript. The namespace is inferred from the project\u2019s Gradle path.</li> <li>are single-variant by default, set to <code>release</code>.</li> </ul>"},{"location":"architecture/#kotlin-configurations","title":"Kotlin Configurations","text":"<p>Kotlin projects are configured with KGP and Detekt in mind. SGP supports configuring Android, JVM, Multiplatform, and Compose Multiplatform projects. Multiplatform for targets other than JVM/android is limited at the moment.</p> <p>Common configurations include:</p> <ul> <li>Setting computed kotlin daemon JVM args.</li> <li>Setting the <code>jvmToolchain</code> to align with the repo\u2019s JDK target.</li> <li>Configuring <code>KotlinCompilation</code> tasks with common configurations.</li> <li>Enabling <code>allWarningsAsErrors</code>.</li> <li>Adding free compiler args to <code>freeCompilerArgs</code>.<ul> <li>If a JVM compilation, add extra JVM args + set <code>jvmTarget</code> and <code>javaParameters</code>.</li> <li>Dynamic, dependency-based compiler args are also set via <code>StandardProjectConfigurations.configureFreeKotlinCompilerArgs()</code>. This is an annoying thing to have to do, but necessary because kotlinc will complain if you add opt-ins that are not recognized by any dependencies on that classpath.</li> </ul> </li> <li>Enabling K2 testing.</li> <li>Configure Detekt, if enabled, via <code>DetektTasks</code>.</li> <li>Configure Lint if not an Android project via the <code>com.android.lint</code> plugin and <code>LintTasks</code>.</li> <li>Configure the <code>src/{variant}/kotlin</code> source set in android projects, as  these are still not automatically enabled.</li> <li>Prevent use of the deprecated <code>android.extensions</code> extension.</li> <li>Configure kapt (if requested) with common configuration</li> <li><code>correctErrorTypes</code> is set to true for better error messages.</li> <li><code>mapDiagnosticLocations</code> is set to false because it\u2019s broken.</li> <li>Unless opted-in, disables kapt in tests due to this.</li> </ul>"},{"location":"architecture/#apkversioningplugin","title":"ApkVersioningPlugin","text":"<pre><code>plugins {\nid(\"com.slack.gradle.apk-versioning\")\n}\n</code></pre> <p>This plugin is applied in Android application projects and is solely to configure the <code>versionCode</code> and <code>versionName</code> of APKs based on git and Gradle property inputs.</p> <p>The following properties are sourced</p> <pre><code>versionMajor=...\nversionMinor=...\nversionPatch=...\n</code></pre> <p>This also adds a <code>generateVersionProperties</code> task that is more or less only relevant for Slack\u2019s internal CI.</p>"},{"location":"architecture/#agp-handlers","title":"AGP Handlers","text":"<p>SGP is designed to work with multiple versions of AGP at a time, albeit only for forward compatibility and testing reasons. Generally SGP will only be tested against the latest stable version of AGP. To support multiple beta/canary versions of upcoming AGP versions, SGP has an API called <code>AgpHandler</code>, which is intended to be an AGP-agnostic common interface for configuring AGP projects across breaking API (source or binary) changes. When a new such change is introduced, we create an <code>AgpHandler{version}</code> artifact and implementation with that AGP version as its minimum. At runtime, SGP loads the relevant <code>AgpHandler</code> instance for the AGP version it is running against and relevant APIs use this instance via <code>SlackTools</code> to interact with them in a version-agnostic way. These aren\u2019t always needed so there may be times when there are no implementations needed for the current suite of AGP versions.</p> <p>An example handler for AGP 8.0 looks like this.</p> <pre><code>// AutoService makes it available via ServiceLoader\n// The factory should always be AGP-api agnostic.\nclass AgpHandler80 : AgpHandler {\n@Suppress(\"DEPRECATION\")\noverride val agpVersion: String\nget() = com.android.builder.model.Version.ANDROID_GRADLE_PLUGIN_VERSION\n\n@AutoService(AgpHandlerFactory::class)\nclass Factory : AgpHandlerFactory {\noverride val minVersion: VersionNumber = VersionNumber.parse(\"8.0.0\")\n\n@Suppress(\"DEPRECATION\")\noverride fun currentVersion(): String =\ncom.android.builder.model.Version.ANDROID_GRADLE_PLUGIN_VERSION\n\noverride fun create(): AgpHandler {\nreturn AgpHandler80()\n}\n}\n}\n</code></pre>"},{"location":"bootstrap/","title":"Bootstrap","text":"<p>Bootstrap is a tool for bootstrapping local dev environments. This is usually used in tandem with a bootstrap bash script that runs the <code>./gradlew bootstrap</code> task and any other repo-specific setups.</p> <p>The core implementation lives in <code>BootstrapTask.kt</code>.</p> <p>At a high level, bootstrap is mostly focused on configuring the JDK and daemon environments. Gradle has extremely limited configurability for the Gradle daemon, and we want to optimize the JDK for available space on different developer machines. To support this, we compute optimal daemon jvm arguments in bootstrap and write them to the user\u2019s home <code>~/.gradle/gradle.properties</code> to override repo-specific settings with client-side properties.</p> <p>For the JDK, it requests the JDK toolchain from Gradle\u2019s first-party APIs. This includes allowing Gradle to download the JDK if it\u2019s missing, which is useful for getting developers set up and running faster.</p> <p>Bootstrap is also useful on CI for its ability to scale available memory to the machine it\u2019s running on, so we generally run it as a preflight step for all of our CI jobs too.</p> <p>Finally, there are some other specific things it does to optimize things:</p> <ul> <li>Disable Gradle file watching on CI as it\u2019s not necessary there.</li> <li>Configure specific GC and heap args for optimized use in Gradle builds (favoring larger young generation spaces).</li> <li>Configure a fixed-size heap for CI to avoid time spent growing the heap.</li> </ul>"},{"location":"changelog/","title":"Changelog","text":""},{"location":"changelog/#0115","title":"0.11.5","text":"<p>2023-11-09</p> <ul> <li>Support AGP <code>8.3.0-alpha13</code>.</li> </ul>"},{"location":"changelog/#0114","title":"0.11.4","text":"<p>2023-11-08</p> <ul> <li>Detekt baselines are now generated into their corresponding projects. This matches how we handle lint baselines, and global baselines are no longer supported.</li> <li>You do now need to specify a <code>slack.detekt.baseline-file-name</code> property to indicate what the simple file name should be. This is evaluated against <code>project.layout.projectDirectory.file(...)</code>. This replaces the previous <code>slack.detekt.baseline</code> property.</li> <li>Build against Kotlin <code>1.9.20</code>.</li> <li>Build against AGP <code>8.1.3</code>.</li> <li>Build against Compose Multiplatform <code>1.5.10</code>.</li> </ul>"},{"location":"changelog/#0113","title":"0.11.3","text":"<p>2023-11-02</p> <ul> <li>Support Robolectric 4.11 jars for Android API 34.</li> </ul>"},{"location":"changelog/#0112","title":"0.11.2","text":"<p>2023-10-30</p> <ul> <li>Make detekt and lint baselines default to <code>null</code> if their property values are blank.</li> <li>No longer publish monkeypatch artifact as it\u2019s no longer necessary.</li> </ul>"},{"location":"changelog/#0111","title":"0.11.1","text":"<p>2023-10-22</p> <ul> <li>Add new <code>sgp.isTestLibrary</code> property to indicate if a library is a test library. Note that projects that are named <code>test-fixtures</code> are implicitly considered test libraries.</li> <li>Fix: Don\u2019t impose <code>VisibleForTests</code> lint on test libraries.</li> </ul>"},{"location":"changelog/#0110","title":"0.11.0","text":"<p>2023-10-22</p> <ul> <li>Revamp some lint configuration and best-effort support KMP projects.</li> <li>Remove <code>slack.lint.update-baselines</code> property in favor of AGP\u2019s modern <code>updateBaselines</code> task.</li> <li>Remove hidden <code>ImplicitSamInstance</code> lint config.</li> <li>Disable newer issues for dependency checks.</li> </ul>"},{"location":"changelog/#01011","title":"0.10.11","text":"<p>2023-10-19</p> <ul> <li>Support AGP <code>8.3.0-alpha08</code>.</li> <li>Build against Gradle <code>8.4</code>.</li> <li>Build against compose-multiplatform <code>1.5.3</code>.</li> </ul>"},{"location":"changelog/#01010","title":"0.10.10","text":"<p>2023-10-02</p> <ul> <li>Make debug builds everywhere (local and CI) use consistent version codes and version names. This way remote build cache entries for them are compatible.</li> <li>Default debug version code is governed by <code>slack.gradle.debugVersionCode</code> and defaults to <code>90009999</code>.</li> <li>Default version name user suffix is governed by <code>slack.gradle.debugUserString</code> and defaults to <code>debug</code>.</li> <li>Non-debug build types are the same as before.</li> <li>Remove a noisy lifecycle log around lint variant selection.</li> <li>Build against Bugsnag Gradle Plugin <code>8.1.0</code>.</li> </ul>"},{"location":"changelog/#0109","title":"0.10.9","text":"<p>2023-09-28</p> <ul> <li>Don\u2019t disable caching on MergeAssets tasks by default. Leave that to consuming repos.</li> <li>Update permission allowlist API to use a <code>allowListFile</code> file property instead.</li> <li>Don\u2019t exclude coroutines\u2019 debug probes in debug build packaging.</li> <li>Support AGP 8.3.0-alpha05+.</li> <li>Build against Wire <code>4.9.1</code>.</li> <li>Build against Compose Multiplatform <code>1.5.2</code>.</li> <li>Update to Oshi <code>6.4.6</code>.</li> </ul>"},{"location":"changelog/#0108","title":"0.10.8","text":"<p>2023-09-22</p> <ul> <li>Fix: Don\u2019t apply boms to the <code>coreLibraryDesugaring</code> configuration.</li> <li>Enhancement: Set Kotlin <code>compilerOptions.moduleName</code> to a dashified version of the Gradle project path.</li> <li>Update MoshiX to <code>0.24.3</code></li> <li>Compile against Anvil <code>2.4.8</code>.</li> <li>Compile against CM <code>1.5.1</code>.</li> <li>Compile against DAGP <code>1.22.0</code>.</li> <li>Compile against redacted-compiler-plugin <code>1.6.1</code>.</li> </ul>"},{"location":"changelog/#0107","title":"0.10.7","text":"<p>2023-08-29</p> <ul> <li>Fix: Don\u2019t apply BOMs to testApi configurations.</li> </ul>"},{"location":"changelog/#0106","title":"0.10.6","text":"<p>2023-08-29</p> <ul> <li>New: Publish a generic Tracing API under the <code>sgp-tracing</code> artifact ID. We use this internally to collect extra build metadata, but it\u2019s generic enough for general use. Not currently used in slack-plugin yet.</li> <li>Add <code>sgp.android.buildToolsVersionOverride</code> property to override the default build tools version in Android.</li> <li>Migrate to <code>AndroidPluginVersion</code> API in <code>AgpHandler</code>.</li> <li>Fix a few more deprecated Gradle API usages.</li> <li>Build against AGP <code>8.1.1</code>.</li> <li>Build against Spotless <code>6.21.0</code>.</li> <li>Build against Compose Multiplatform <code>1.5.0</code>.</li> <li>Update to Kotlin <code>1.9.10</code>.</li> <li>Update to KSP <code>1.9.10-1.0.13</code>.</li> <li>Update to RxJava <code>3.1.7</code>.</li> <li>Update to kotlin-cli-util <code>2.2.1</code>.</li> <li>Update to Oshi <code>6.4.5</code>.</li> <li>Update to Wire <code>4.8.1</code></li> <li>Update to DAGP <code>1.21.0</code>.</li> <li>Update to Gradle <code>8.3</code>.</li> </ul>"},{"location":"changelog/#0105","title":"0.10.5","text":"<p>2023-08-15</p> <ul> <li>Fix: Better support <code>com.android.test</code> projects in a few ways</li> <li>No longer apply lint configurations as they don\u2019t support them.</li> <li>No longer apply DAGP as it doesn\u2019t support them yet.</li> <li>No longer apply unit test configurations as they don\u2019t have unit tests.</li> <li>Build against Gradle 8.3 + fix a few deprecated <code>Project.buildDir</code> API usages.</li> <li>Update <code>kotlin-cli-util</code> to <code>2.1.0</code>.</li> </ul>"},{"location":"changelog/#0104","title":"0.10.4","text":"<p>2023-08-10</p> <ul> <li>New: New DSL API for enabling Android resources.</li> </ul> <p>This streamlines configuration of enabling <code>androidResources</code> and enforces use of a resource prefix to avoid conflicts.</p> <p>May your avatars never be wrongly sized again.</p> <pre><code>slack {\nandroid {\nfeatures {\nresources(\"prefix_\")\n}\n}\n}\n</code></pre> <ul> <li>Update kotlin-cli-util to <code>2.0.0</code>.</li> <li>Update Moshi to <code>1.15.0</code>.</li> <li>Update sort-dependencies to <code>0.4</code>.</li> <li>Update KSP to <code>1.9.0-1.0.13</code>.</li> <li>Update Okio to <code>3.5.0</code>.</li> <li>Update Jetbrains Markdown to <code>0.5.0</code>.</li> </ul>"},{"location":"changelog/#0103","title":"0.10.3","text":"<p>2023-08-08</p> <ul> <li>Fix an issue with Skippy where we would accidentally mark all library projects as affected androidTest projects even if they didn\u2019t have androidTest enabled.</li> <li>Update Guava to <code>32.1.2-jre</code>.</li> </ul>"},{"location":"changelog/#0102","title":"0.10.2","text":"<p>2023-08-08</p> <ul> <li>Apparently the bugsnag plugin relies on the version code to be set in the variant output, so now we set a default again (configurable via <code>slack.gradle.defaultVersionCode</code>). The default is <code>90009999</code>, for reasons.</li> </ul>"},{"location":"changelog/#0101","title":"0.10.1","text":"<p>2023-08-07</p> <ul> <li>Use a single version code for all APK architectures.</li> <li>Before, we used to compute a different version code for each architecture. This is kinda silly, and broke with AGP 8.1.0. So now we no longer do this. This means that by default, no custom version code is set unless an override is set in <code>{rootProject}/build/ci/release.version</code>. The default behavior will be to just use the version set in the <code>android</code> DSL.</li> <li>Update to Detekt <code>1.23.1</code>.</li> <li>Update to Gradle Enterprise <code>3.14.1</code>.</li> <li>Update to Compose Multiplatform <code>1.4.3</code>.</li> <li>Update to SqlDelight <code>2.0.0</code>.</li> <li>Update to Anvil <code>2.4.7</code>.</li> </ul>"},{"location":"changelog/#0100","title":"0.10.0","text":"<p>2023-07-25</p> <ul> <li>Update to Kotlin <code>1.9.0</code>.</li> <li>Update to KSP <code>1.9.0-1.0.12</code>.</li> <li>Update to AGP <code>8.1.0</code>.</li> <li>Update kotlin-cli-util to <code>1.2.3</code>.</li> <li>Update MoshiX to <code>0.24.0</code>.</li> <li>Update redacted to <code>1.5.0</code>.</li> <li>Update wire to <code>4.8.0</code>.</li> <li>Add new dagger flag to ignore wildcard keys by default.</li> <li>https://dagger.dev/dev-guide/compiler-options#ignore-provision-key-wildcards</li> </ul>"},{"location":"changelog/#0918","title":"0.9.18","text":"<p>2023-07-12</p> <ul> <li>Fix: Differentiate unit and instrumentation tests in Skippy. Now changing a unit test will not cause the instrumentation tests to be marked as affected.</li> <li>Add <code>slack.dependencyrake.dryRun</code> gradle property flag for dependency rake to enable dry-run. If enabled, the project build files will not be modified and a separate <code>new-build.gradle.kts</code> file will be written to instead.</li> <li>Update Okio to <code>3.4.0</code>.</li> </ul>"},{"location":"changelog/#0917","title":"0.9.17","text":"<p>2023-07-07</p> <ul> <li>Don\u2019t register <code>RakeDependencies</code> task on platform projects.</li> <li>Fix configuration cache for Dependency Rake. Note that DAGP doesn\u2019t yet support it.</li> <li>Add Dependency Rake usage to its doc.</li> <li>Add missing identifiers aggregation for Dependency Rake. This makes it easier to find and add missing identifiers to version catalogs that dependency rake expects.</li> <li><code>./gradlew aggregateMissingIdentifiers -Pslack.gradle.config.enableAnalysisPlugin=true --no-configuration-cache</code></li> </ul>"},{"location":"changelog/#0916","title":"0.9.16","text":"<p>2023-06-30</p> <ul> <li>Enable lint on test sources by default.</li> <li>Account for all version catalogs in <code>DependencyRake</code>.</li> <li>Update Guava to <code>32.1.0-jre</code>.</li> </ul>"},{"location":"changelog/#0915","title":"0.9.15","text":"<p>2023-06-29</p> <ul> <li>Switch Robolectric jar downloads to use detached configurations.</li> <li>This lets Gradle do the heavy lifting of caching the downloaded jars and also allows downloading them from a configured repository setup. This also simplifies the up-to-date checks.</li> <li>Docs are now published on https://slackhq.github.io/slack-gradle-plugin. This is a work in progress.</li> <li>API kdocs are published at https://slackhq.github.io/slack-gradle-plugin/api/0.x/.</li> <li>Update <code>kotlin-cli-util</code> to 1.2.2.</li> </ul>"},{"location":"changelog/#0914","title":"0.9.14","text":"<p>2023-06-25</p> <ul> <li>Fix compose compiler config not applying to android projects.</li> </ul>"},{"location":"changelog/#0913","title":"0.9.13","text":"<p>2023-06-24</p> <ul> <li>Fix wrong map key name being used in exclusion.</li> </ul>"},{"location":"changelog/#0912","title":"0.9.12","text":"<p>2023-06-24</p> <ul> <li>Fix wrong dependency being used for compose-compiler in new Compose configuration overhaul.</li> </ul>"},{"location":"changelog/#0911","title":"0.9.11","text":"<p>2023-06-24</p> <ul> <li>Overhaul configuration of the Compose compiler across Android and multiplatform projects to make it easier to test the matrix of the AndroidX compose compiler, the JetBrains compose compiler, and new Kotlin versions.</li> <li>New: Add a <code>sgp.compose.multiplatform.forceAndroidXComposeCompiler</code> Gradle property flag to force use of the AndroidX compose compiler in Compose Multiplatform projects.</li> <li>New: Add a <code>sgp.config.jvmVendor.optOut</code> Gradle property flag to disable jvmVendor configuration in toolchains.</li> <li>Fix: No longer try to watch thermals on Intel macOS machines when configuration cache is enabled.</li> </ul>"},{"location":"changelog/#0910","title":"0.9.10","text":"<p>2023-06-06</p> <ul> <li>Fix: Don\u2019t apply vendor property to Bootstrap toolchain if it\u2019s undefined.</li> </ul>"},{"location":"changelog/#099","title":"0.9.9","text":"<p>2023-06-06</p> <ul> <li>New: Robolectric is now optional. Its support will only be enabled if there is a <code>robolectric</code> key in the primary version catalog.</li> <li>Enhancement: Update bootstrap JVM args to use ExitOnOutOfMemoryError for OOMs. No longer takes a heap dump on OOM.</li> <li>Enhancement: Update unit test verbose mode to use CrashOnOutOfMemoryError for OOMs to produce more logs.</li> <li>Fix: Bootstrap now respects the <code>sgp.config.jvmVendor</code> property.</li> <li>Build against Wire to <code>4.7.0</code>.</li> <li>Build against Anvil <code>2.4.6</code>.</li> <li>Build against AGP <code>8.0.2</code>.</li> <li>Build against Detekt <code>1.23.0</code>.</li> </ul>"},{"location":"changelog/#098","title":"0.9.8","text":"<p>2023-05-15</p> <ul> <li>Fix eager check of whether or not androidTest is enabled in <code>slack</code> DSL.</li> </ul>"},{"location":"changelog/#097","title":"0.9.7","text":"<p>2023-05-15</p> <ul> <li>Fix application targets not getting marked as androidTest()-enabled.</li> </ul>"},{"location":"changelog/#096","title":"0.9.6","text":"<p>2023-05-09</p> <ul> <li>Fix wrong use of <code>disallowChanges()</code> on <code>javaCompiler</code> in JavaCompile tasks. It seems that Gradle sets this multiple times.</li> <li>Improve git version matching.</li> </ul>"},{"location":"changelog/#095","title":"0.9.5","text":"<p>2023-05-09</p> <ul> <li>Use <code>disallowChanges()</code> where possible on properties SGP controls in order to avoid accidental overwrites.</li> <li>Make <code>ComputeAffectedProjectsTask</code> also generate a <code>affected_android_test_projects.txt</code> file with a newline-delimited list of affected projects that enable <code>androidTest()</code>. This can be used in CI scripts to statically determine if instrumentation tests need to run.</li> </ul>"},{"location":"changelog/#094","title":"0.9.4","text":"<p>2023-05-06</p> <ul> <li>Fix alias naming in <code>SlackVersions</code>. See <code>SlackVersions.kt</code> for updated expected naming of aliases.</li> </ul>"},{"location":"changelog/#093","title":"0.9.3","text":"<p>2023-05-05</p> <ul> <li>Add <code>jdk.compiler/com.sun.tools.javac.model</code> to Bootstrap Gradle JVM args and exec prefixes for binaries for GJF 17.</li> </ul>"},{"location":"changelog/#092","title":"0.9.2","text":"<p>2023-05-05</p> <ul> <li>Fix accidental noisy JVM vendor log.</li> </ul>"},{"location":"changelog/#091","title":"0.9.1","text":"<p>2023-05-04</p> <p>Happy May the Fourth!</p> <ul> <li>Add new <code>sgp.config.jvmVendor</code> property to control the JVM vendor used in Kotlin and Java toolchains. This value is used to match a known vendor spec, such as <code>AZUL</code>.</li> <li>Apply the kover plugin in an <code>afterEvaluate</code> block to avoid https://github.com/Kotlin/kotlinx-kover/issues/362.</li> <li>Update jgrapht to 1.5.2.</li> <li>Update oshi to 6.4.2.</li> </ul>"},{"location":"changelog/#090","title":"0.9.0","text":"<p>2023-04-30</p> <ul> <li>Improve Skippy logging.</li> <li>Configure all Kotlin compilations, not just JVM compilations.</li> <li>Split standard JVM args and common Kotlin args.</li> <li>Simplify <code>OkHttpClient</code> setup in <code>SlackTools</code>.</li> <li>Update to Kotlin 1.8.21.</li> <li>Support Dagger KSP in <code>slack.features.dagger</code> DSL controls. There are two new properties to control this:</li> <li><code>slack.ksp.allow-dagger</code> \u2013 allow use of Dagger in KSP.</li> <li><code>slack.ksp.allow-anvil</code> \u2013 allow use of Anvil in KSP. Note this is not yet implemented in Anvil, just a toe-hold for the future.</li> <li>Add debugging logs for loading <code>SlackToolsExtension</code> instances + fix classloader used for it.</li> <li>Gracefully handle <code>SlackToolsExtension</code> extensions that fail to load.</li> </ul>"},{"location":"changelog/#0810","title":"0.8.10","text":"<p>2023-04-25</p> <ul> <li>Add <code>Context</code> to <code>SlackToolsExtension</code>.</li> </ul>"},{"location":"changelog/#089","title":"0.8.9","text":"<p>2023-04-25</p> <ul> <li>Expose missing <code>SlackTools.findExtension</code> API.</li> <li>Expose missing <code>SlackTools.SERVICE_NAME</code> for <code>@ServiceReference</code> API.</li> </ul>"},{"location":"changelog/#088","title":"0.8.8","text":"<p>2023-04-25</p> <ul> <li>Update to Kotlin 1.8.20.</li> <li>Remove <code>moshi-kotlin</code>, only use generated adapters now.</li> <li>Don\u2019t auto-apply the Kover plugin on a platform project.</li> <li>Add new <code>sgp.ge.apply-common-build-tags</code> property flag to gate applying common build tags to a project.</li> <li>Switch <code>SlackToolsExtension</code> to work as a <code>ServiceLoader</code> instead.</li> </ul>"},{"location":"changelog/#087","title":"0.8.7","text":"<p>2023-04-23</p> <ul> <li>Remove lock file checking in <code>SlackTools</code> because this apparently invalidates configuration cache every time.</li> </ul>"},{"location":"changelog/#086","title":"0.8.6","text":"<p>2023-04-22</p> <ul> <li>Revert using native Kotlin lambdas instead of <code>class</code> for SAM conversions due to https://github.com/gradle/gradle/issues/24871.</li> </ul>"},{"location":"changelog/#085","title":"0.8.5","text":"<p>2023-04-22</p> <ul> <li>Clean up thermals logging setup in <code>SlackTools</code> and support enabling property at different scopes (local.properties, etc).</li> <li>Shut down thermals heartbeat executor when <code>SlackTools</code> is closed.</li> <li>Use native Kotlin lambdas instead of <code>class</code> for SAM conversions. The minimum supported Gradle version is now 8.1, which introduced support for this.</li> </ul>"},{"location":"changelog/#084","title":"0.8.4","text":"<p>2023-04-22</p> <ul> <li>Fix JSON serialization for thermals data.</li> </ul>"},{"location":"changelog/#083","title":"0.8.3","text":"<p>2023-04-22</p> <ul> <li>Don\u2019t accidentally create new <code>SlackTools</code> instances when reporting background data to Gradle Enterprise. These instances would be orphaned because this would happen after Gradle had closed all existing services, and create a memory leak.</li> <li>Use a lock file to track <code>SlackTools</code> instances.</li> <li>Use a single-threaded <code>Executor</code> for <code>SlackTools</code>\u2018 thermals heartbeat.</li> </ul>"},{"location":"changelog/#082","title":"0.8.2","text":"<p>2023-04-22</p> <ul> <li>Log a <code>Throwable</code> with multiple instances of <code>SlackTools</code> to help track origin points.</li> </ul>"},{"location":"changelog/#081","title":"0.8.1","text":"<p>2023-04-22</p> <ul> <li>Add some debug logging to <code>SlackTools</code> to track multiple instances.</li> </ul>"},{"location":"changelog/#080","title":"0.8.0","text":"<p>2023-04-15</p> <ul> <li>Fix: Wrap all exec operations in a <code>ValueSource</code> for Gradle 8.x compatibility.</li> <li>Fix: Set git line endings to <code>PLATFORM_NATIVE</code> in spotless by default. Its default of looking at <code>.gitattributes</code> is expensive and incompatible with Gradle 8.1+ configuration caching.</li> <li>Fix: Add <code>slack.auto-apply.sort-dependencies</code> boolean Gradle property to gate auto-applying the sort-dependencies plugin.</li> <li>SGP now requires AGP 8.0+ (and with it \u2013 Gradle 8+).</li> </ul>"},{"location":"changelog/#079","title":"0.7.9","text":"<p>2023-04-01</p> <p>Happy April Fool\u2019s Day!</p> <ul> <li>[Skippy] Recursively resolve project dependencies to avoid missing transitive edges in the graph. Previously we only computed shallow dependencies.</li> </ul>"},{"location":"changelog/#078","title":"0.7.8","text":"<p>2023-03-28</p> <ul> <li>Fix: Add missing <code>detekt</code> task dependencies for <code>globalDetekt</code>.</li> <li>Fix: Only apply detekt config once (even if multiple Kotlin plugins are applied).</li> </ul>"},{"location":"changelog/#077","title":"0.7.7","text":"<p>2023-03-27</p> <ul> <li>Add new <code>slack.detekt.full</code> property to gate whether or to run full detekt (i.e. with type resolution). If disabled, <code>detektRelease</code>/<code>detektMain</code> and associated tasks will be disabled and not used in <code>detektGlobal</code>.</li> </ul>"},{"location":"changelog/#076","title":"0.7.6","text":"<p>2023-03-25</p> <ul> <li>Fix: Apply matching configurations to <code>DetektCreateBaselineTask</code> tasks too due to https://github.com/detekt/detekt/issues/5940.</li> </ul>"},{"location":"changelog/#075","title":"0.7.5","text":"<p>2023-03-24</p> <ul> <li>[Skippy] Add more default configurations.</li> <li>[Skippy] Add <code>slack.avoidance.build-upon-default-affected-project-configurations</code> flag to make provided configurations build upon defaults.</li> <li>Add new <code>globalDetekt</code> task that runs <code>detekt</code> on all subprojects. This is Skippy-compatible and responds to <code>slack.avoidance.affectedProjectsFile</code>.</li> </ul>"},{"location":"changelog/#074","title":"0.7.4","text":"<p>2023-03-22</p> <ul> <li>Don\u2019t expose <code>androidExtension</code> publicly in <code>SlackExtension</code> to avoid Gradle mismatching number of type arguments in AGP 8.1.0-alpha10+.</li> </ul>"},{"location":"changelog/#073","title":"0.7.3","text":"<p>2023-03-22</p> <ul> <li>Set <code>Detekt.jdkHome</code> to null to avoid https://github.com/detekt/detekt/issues/5925.</li> <li>Rename <code>String.safeCapitalize()</code> to <code>String.capitalizeUS()</code> to make it more explicit.</li> </ul>"},{"location":"changelog/#072","title":"0.7.2","text":"<p>2023-03-21</p> <ul> <li>Disable Live Literals in Compose by default due to multiple issues. They can be enabled via <code>-Pslack.compose.android.enableLiveLiterals=true</code>.</li> <li>Poor runtime performance: https://issuetracker.google.com/issues/274207650.</li> <li>Non-deterministic class files breaking build cache: https://issuetracker.google.com/issues/274231394.</li> <li>[Skippy] Add <code>.github/actions/**</code> to default never skip filters.</li> </ul>"},{"location":"changelog/#071","title":"0.7.1","text":"<p>2023-03-20</p> <ul> <li>[Skippy] Improve pattern configuration.</li> <li>Make the default patterns public. This allows consumers to more      easily reuse them when customizing their own.</li> <li>Use sets for the type to better enforce uniqueness requirements.</li> <li>Add github actions to never-skip defaults.</li> <li>Add excludePatterns to allow finer-grained control. This runs after      include filtering so that users can manually exclude certain files that      may otherwise be captured in an inclusion filter and is difficult to      describe in a simple glob pattern. GitHub action does similar controls      for CI matrices.</li> <li>[Skippy] Allow relative (from the project root) to <code>affected_projects.txt</code> and allow non-existent files as a value. This makes it easy to gracefully fall back in CI.</li> <li>[Skippy] Fix logging path matchers missing toString() impls.</li> <li>[SKippy] Log verbosely in debug mode when skipping task deps.</li> <li>Update oshi to <code>6.4.1</code>.</li> </ul>"},{"location":"changelog/#070","title":"0.7.0","text":"<p>2023-03-17</p>"},{"location":"changelog/#project-skippy","title":"Project Skippy","text":"<p>This release introduces an experimental new <code>computeAffectedProjects</code> task for computing affected projects based on an input of changed files. The goal of this is to statically detect which unit test, lint, and androidTest checks can be safely skipped in CI on pull requests.</p> <p>Example usage <pre><code>./gradlew computeAffectedProjects --changed-files changed_files.txt\n</code></pre></p> <p>Where <code>changed_files.txt</code> is resolved against the root repo directory and contains a newline-delimited list of changed files (usually inferred from a PR).</p> <p>A simple example of how to produce such a file with the <code>gh</code> CLI:</p> <pre><code>gh pr view ${{ github.event.number }} --json files -q '.files[].path' &gt; changed_files.txt\n</code></pre> <p>One would run this task first as a preflight task, then run subsequent builds with the <code>slack.avoidance.affectedProjectsFile</code> Gradle property pointing to its output file location (printed at the end of the task).</p> <pre><code>./gradlew ... -Pslack.avoidance.affectedProjectsFile=/Users/zacsweers/dev/slack/slack-android-ng/build/skippy/affected_projects.txt\n</code></pre> <p>The <code>globalCiLint</code>, <code>globalCiUnitTest</code>, and <code>aggregateAndroidTestApks</code> tasks all support reading this property and will avoid adding dependencies on tasks in projects that are not present in this set.</p> <p>The <code>ComputeAffectedProjectsTask</code> task has some sensible defaults, but can be configured further in the root projects like so.</p> <pre><code>tasks.named&lt;ComputeAffectedProjectsTask&gt;(\"computeAffectedProjects\") {\n// Glob patterns of files to include in computing\nincludePatterns.addAll(\n\"**/*.kt\",\n\"**/*.java\",\n)\n// Glob patterns of files that, if changed, should result in not skipping anything in the build\nneverSkipPatterns.addAll(\n\"**/*.versions.toml\",\n\"gradle/wrapper/**\",\n)\n}\n</code></pre> <p>Debug logging can be enabled via the <code>slack.debug=true</code> Gradle property. This will output timings, logs, and diagnostics for the task.</p> <p>The configurations used to determine the build graph can be customized via comma-separated list to the <code>slack.avoidance.affected-project-configurations</code> property.</p>"},{"location":"changelog/#061","title":"0.6.1","text":"<p>2023-03-15</p> <p>Happy Ted Lasso season 3 premier day!</p> <ul> <li>Fix: Remove <code>UseContainerSupport</code> jvm arg from unit tests as this appears to only work on Linux.</li> </ul>"},{"location":"changelog/#060","title":"0.6.0","text":"<p>2023-03-14</p> <p>Happy Pi day!</p> <ul> <li>Refactor how unit tests are configured.</li> <li><code>Test</code> tasks are now configured more consistently across CI and local, so there should be more cache hits.</li> <li>Add a new <code>globalCiUnitTest</code> task to the root project to ease running <code>ciUnitTest</code> tasks across all subprojects.</li> <li>Add new properties to <code>SlackProperties</code> for controlling max parallelism and <code>forkEvery</code> options in <code>Test</code> tasks.</li> <li>Refactor how lint tasks are configured.</li> <li>Add a new <code>ciLint</code> task to every project that depends on all lint tasks in that project. This is intended to be the inverse     behavior of the built-in <code>lint</code> task in Android projects, which only runs the default variant\u2019s lint task.</li> <li>Add a new <code>globalCiLint</code> task to the root project to ease running <code>ciLint</code> tasks across all subprojects.</li> <li>Add new properties to <code>SlackProperties</code> for controlling which variants should be linted.</li> <li>Revert \u201cAdd lintErrorRuleIds property\u201d. <code>lint.xml</code> is the right place for this kind of logic.</li> </ul>"},{"location":"changelog/#0510","title":"0.5.10","text":"<p>2023-03-07</p> <ul> <li>Reduce noisy JNA load failures logging. Still have not gotten to the root cause, but at least this will reduce the log noise.</li> <li>Add a new <code>slack.lint.severity.errorRuleIds</code> Gradle property to specify lint rule IDs that should always be error severity.</li> </ul>"},{"location":"changelog/#059","title":"0.5.9","text":"<p>2023-02-27</p> <ul> <li>Gracefully handle JNA load failures in thermals logging.</li> </ul>"},{"location":"changelog/#058","title":"0.5.8","text":"<p>2023-02-20</p> <ul> <li>Enhancement: Remove kotlin-dsl from the plugin. If you were indirectly relying on its APIs from this plugin, you\u2019ll need to add that dependency separately.</li> <li>Enhancement: Better support fully modularized lints</li> <li><code>checkDependencies</code> is no longer enabled by default.</li> <li>Make the baseline file name configurable via <code>slack.lint.baseline-file-name</code> property. Defaults to <code>lint-baseline.xml</code>.</li> <li>Fix: <code>ImplicitSamInstance</code> lint not being enabled.</li> </ul>"},{"location":"changelog/#057","title":"0.5.7","text":"<p>2023-02-15</p> <ul> <li>Fix: <code>MergeFileTask.kt</code> was accidentally removed during a previous release.</li> <li>Fix: Add <code>jna-platform</code> dependency to align with the <code>jna</code> dependency version.</li> </ul>"},{"location":"changelog/#056","title":"0.5.6","text":"<p>2023-02-15</p> <p>Do not use! Release was accidentally messed up.</p>"},{"location":"changelog/#055","title":"0.5.5","text":"<p>2023-02-13</p> <ul> <li>Fix: <code>LocTask</code> is now compatible with Gradle 8.0 and has the correct task dependencies when Ksp, Kapt, etc are running.</li> <li>Fix: <code>LocTask</code> is now compatible with remote build cache.</li> <li>Enhancement: ModScore now supports KSP.</li> <li>Enhancement: Binary download tasks (<code>KtfmtDownloadTask</code>, <code>DetektDownloadTask</code>, etc) now have prettier and more reliable download progress indications.</li> <li>Enhancement: <code>UpdateRobolectricJarsTask</code> now uses Gradle workers to parallelize downloads. On gigabit wifi, this takes the task runtime down from ~21sec to ~13sec.</li> <li>Enhancement: The boolean <code>SLACK_FORCE_REDOWNLOAD_ROBOLECTRIC_JARS</code> env variable can be used to force <code>UpdateRobolectricJarsTask</code> to redownload jars even if already downloaded. Behavior change: Mod score must now be opted in to via the <code>slack.gradle.config.modscore.enabled=true</code> gradle property.</li> <li>Enhancement: Mod score can be disabled per-project via the <code>slack.gradle.config.modscore.ignore=true</code> gradle property.</li> </ul>"},{"location":"changelog/#054","title":"0.5.4","text":"<p>2023-02-07</p> <ul> <li>New: Integrate gradle-dependency-sorter as another formatter. This automatically apply if the <code>sortDependencies</code> toml version is present, and you can have it download+create executable binaries via <code>./gradlew downloadDependenciesSorter</code>.</li> <li>Enhancement: Improve compose multiplatform support. Now the <code>compose()</code> DSL is moved to <code>slack.features</code> and offers an optional <code>multiplatform</code> parameter to enable the compose multiplatform plugin.   <pre><code>slack {\nfeatures {\ncompose(multiplatform = &lt;true|false&gt;)\n}\n}\n</code></pre></li> <li>Build against Kotlin <code>1.8.10</code> and AGP <code>7.4.1</code>.</li> </ul>"},{"location":"changelog/#053","title":"0.5.3","text":"<p>2023-01-27</p> <ul> <li>Fix the <code>MergeFilesTask</code> monkeypatch using env vars instead of system props.</li> </ul>"},{"location":"changelog/#052","title":"0.5.2","text":"<p>2023-01-26</p> <ul> <li>Try another fix for the <code>MergeFilesTask</code> monkeypatch plus extra logging. Feel free to skip this update if you\u2019re unaffected.</li> </ul>"},{"location":"changelog/#051","title":"0.5.1","text":"<p>2023-01-23</p> <ul> <li>Fix: Unwrap <code>Optional</code> for <code>google-coreLibraryDesugaring</code> dependency before adding it. The Gradle API\u2019s lack of type safety strikes again.</li> </ul>"},{"location":"changelog/#050","title":"0.5.0","text":"<p>2023-01-23</p> <ul> <li>New: Introduce a new <code>sgp-monkeypatch-agp</code> artifact. This contains monkeypatches for AGP where we try to fix bugs. This initial version contains a patched <code>MergeFilesTask</code> that sorts files before merging them to ensure deterministic outputs, as we believe this is causing our lint tasks to be non-cacheable across machines. This can be enabled via setting the <code>com.slack.sgp.sort-merge-files</code> system property to <code>true</code>.</li> <li>New: Rework how bugsnag is enabled. Instead of only applying the plugin in release/main builds, we now always apply the plugin and only enable uploads on release/main builds. This allows us to catch issues with the plugin in updates sooner, as before we would not see them on PRs.</li> <li>Uploads can be force-enabled via setting the <code>slack.gradle.config.bugsnag.enabled</code> gradle property to true.</li> <li>Branches that allow uploads can be configured via regexp value on the <code>slack.gradle.config.bugsnag.enabledBranchPattern</code> gradle property. For example: <code>slack.gradle.config.bugsnag.enabledBranchPattern=main|release_.*</code>.</li> <li>New: Source desugar libraries from <code>libs.versions.toml</code> instead of assuming the artifact name. Starting with 1.2.0, desugar JDK libs offers multiple artifacts. Point <code>google-coreLibraryDesugaring</code> in [libraries] to whichever artifact should be used.</li> <li>Fix: Catch and print errors with thermal closes.</li> <li>Misc: Update to JDK 19 and latest AGPs. The plugin itself still targets JVM 11 bytecode. AGP 7.4.0 is now required.</li> </ul>"},{"location":"changelog/#042","title":"0.4.2","text":"<p>2023-01-13</p> <ul> <li>Enhancement: Change default gradle memory percent in bootstrap from 25% to 50%.</li> <li>Fix: Support the gradle enterprise plugin retry implementation when using Gradle enterprise 3.12+.</li> </ul>"},{"location":"changelog/#041","title":"0.4.1","text":"<p>2023-01-09</p> <p>Happy new year!</p> <ul> <li>Fix: Remove EitherNet compiler option opt-ins.</li> <li>Update Okio to <code>3.3.0</code>.</li> </ul>"},{"location":"changelog/#040","title":"0.4.0","text":"<p>2022-12-29</p> <ul> <li>Update to Kotlin 1.8.0. This plugin now requires Kotlin 1.8.0 or later as it only configures KGP\u2019s new <code>compilerOptions</code> API now.</li> </ul>"},{"location":"changelog/#038","title":"0.3.8","text":"<p>2022-12-22</p> <ul> <li>Add support for AGP 8.0.0-alpha10.</li> </ul>"},{"location":"changelog/#037","title":"0.3.7","text":"<p>2022-12-19</p> <ul> <li>Fix: Don\u2019t apply freeCompilerArguments.</li> <li>Fix: Add missing license information to published POM files.</li> </ul>"},{"location":"changelog/#036","title":"0.3.6","text":"<p>2022-12-15</p> <ul> <li>Backport <code>android.packagingOptions.jniLibs.pickFirst</code> for AGP 8.x compatibility, as the returned type by <code>jniLibs</code> changed from <code>JniLibsPackagingOptions</code> to <code>JniLibsPackaging</code>.</li> </ul>"},{"location":"changelog/#035","title":"0.3.5","text":"<p>2022-12-06</p> <ul> <li>Introduce <code>compileCiUnitTest</code> lifecycle task to just compile (but not run!) unit tests that are run by <code>ciUnitTest</code>.</li> </ul>"},{"location":"changelog/#034","title":"0.3.4","text":"<p>2022-12-04</p> <ul> <li>Only enable <code>isIncludeAndroidResources</code> in Android unit tests automatically when <code>robolectric()</code> is used.</li> </ul>"},{"location":"changelog/#033","title":"0.3.3","text":"<p>2022-11-11</p> <ul> <li>Add some more Kotlin compiler arguments to compilations. See #160</li> </ul>"},{"location":"changelog/#032","title":"0.3.2","text":"<p>2022-11-10</p> <ul> <li>(Strict mode only) Check for <code>AndroidManifest.xml</code> files in androidTest sources + ensure they\u2019re debuggable.</li> </ul>"},{"location":"changelog/#031","title":"0.3.1","text":"<p>2022-10-20</p> <ul> <li>Exclude <code>**/build/**</code> from <code>Detekt</code> tasks.</li> </ul>"},{"location":"changelog/#030","title":"0.3.0","text":"<p>2022-10-14</p> <ul> <li>New: Support <code>com.android.test</code> projects.</li> <li>New: Preliminary support for AGP 8.x.</li> <li>Automatically add compose compiler dep in Compose multiplatform (i.e. <code>org.jetbrains.compose</code>) projects.</li> <li>Support Error Prone Gradle Plugin 3.x.</li> <li>Update <code>me.tongfei:progressbar</code> to <code>0.9.5</code>.</li> </ul>"},{"location":"changelog/#024","title":"0.2.4","text":"<p>2022-10-06</p> <ul> <li>Fix: Only check allowed androidTest variants if any are defined.</li> </ul>"},{"location":"changelog/#023","title":"0.2.3","text":"<p>2022-10-03</p> <ul> <li>Fix: Only configure bootstrap conditionally.</li> </ul>"},{"location":"changelog/#022","title":"0.2.2","text":"<p>2022-10-03</p> <ul> <li>Add necessary <code>--add-opens</code> to <code>Test</code> tasks for Robolectric 4.9+ when it\u2019s enabled.</li> <li>Avoid <code>subprojects</code> module stats and <code>allprojects</code> in bootstrap for better project isolation support.</li> </ul>"},{"location":"changelog/#021","title":"0.2.1","text":"<p>2022-09-27</p> <ul> <li>Fix: New <code>androidTest(allowedVariants = ...)</code> wasn\u2019t running on <code>com.android.application</code> projects.</li> <li>Fix: Configure <code>Lint</code> DSL block for <code>com.android.library</code> and <code>org.jetbrains.kotlin.jvm</code> projects too.</li> </ul>"},{"location":"changelog/#020","title":"0.2.0","text":"<p>2022-09-23</p> <ul> <li>Add option to enable only certain variants\u2019 android tests.</li> </ul> <pre><code>slack {\nandroid {\nfeatures {\nandroidTest(allowedVariants = setOf(\"internalDebug\"))\n}\n}\n}\n</code></pre>"},{"location":"changelog/#012","title":"0.1.2","text":"<p>2022-09-20</p> <ul> <li>Support Robolectric jars for Android API 30.</li> </ul>"},{"location":"changelog/#011","title":"0.1.1","text":"<p>2022-09-08</p> <ul> <li>Fix wrong <code>slack.unit-test</code> plugin application.</li> </ul>"},{"location":"changelog/#010","title":"0.1.0","text":"<p>2022-09-07</p> <ul> <li>Update to Moshi 1.14.0.</li> <li>Disable <code>Instantiatable</code> lint in min SDK 28+ due to lint bug.</li> <li>Specify kotlin version in compose compatibility check.</li> </ul>"},{"location":"code-of-conduct/","title":"Code of Conduct","text":""},{"location":"code-of-conduct/#introduction","title":"Introduction","text":"<p>Diversity and inclusion make our community strong. We encourage participation from the most varied and diverse backgrounds possible and want to be very clear about where we stand.</p> <p>Our goal is to maintain a safe, helpful and friendly community for everyone, regardless of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other defining characteristic.</p> <p>This code and related procedures also apply to unacceptable behavior occurring outside the scope of community activities, in all community venues (online and in-person) as well as in all one-on-one communications, and anywhere such behavior has the potential to adversely affect the safety and well-being of community members.</p> <p>For more information on our code of conduct, please visit https://slackhq.github.io/code-of-conduct</p>"},{"location":"configuration/","title":"Configuration","text":"<p>TODO</p>"},{"location":"contributing/","title":"Contributors Guide","text":"<p>Note that this project is considered READ-ONLY. You are welcome to discuss or ask questions in the discussions section of the repo, but we do not normally accept external contributions without prior discussion.</p>"},{"location":"contributing/#development","title":"Development","text":"<p>Check out this repo with Android Studio or IntelliJ. It\u2019s a standard gradle project and conventional to check out.</p> <p>The primary project is <code>slack-plugin</code>.</p> <p>Kotlin should be used for more idiomatic use with Gradle/AGP APIs</p> <p>Code formatting is checked via Spotless. To run the formatter, use the <code>spotlessApply</code> command.</p> <pre><code>./gradlew spotlessApply\n</code></pre> <p>Optionally, there are commit hooks in the repo you can enable by running the below <pre><code>git config core.hooksPath config/git/hooks\n</code></pre></p>"},{"location":"dependency-rake/","title":"Dependency Rake","text":"<p>Dependency rake is an tool we develop within slack-gradle-plugin (SGP) to automatically clean up Gradle build files.</p> <p>This tool uses the outputs of the dependency-analysis-gradle-plugin ( DAGP) to infer and apply fixes it recommends.</p>"},{"location":"dependency-rake/#types-of-fixes","title":"Types of Fixes","text":"<p>There are three main categories of fixes that DR applies.</p> <ol> <li>Remove unused dependencies.<ul> <li>Like it says on the tin, these are declared dependencies that are unused and should be removed.</li> </ul> </li> <li>Fix misused dependencies.<ul> <li>These are dependencies that are declared but only transitive dependencies they include are actually used. For   example - depending on RxAndroid but only using RxJava from it. These are fixed by replacing the dependency with   the specific transitive dependency.</li> </ul> </li> <li>Fix wrong configurations.<ul> <li>These are dependencies that declare the wrong Gradle configuration (e.g. api, implementation, etc). Dependencies   determined to be used in the \u201cpublic ABI\u201d of the library should be \u201capi\u201d configuration for use in dependent   projects. Anything else can be hidden as an \u201cimplementation\u201d or \u201ccompileOnly\u201d (if annotations-only) dependency.</li> </ul> </li> </ol>"},{"location":"dependency-rake/#benefits","title":"Benefits","text":"<p>The primary benefit of dependency rake is to improve build times by more or less \u201craking\u201d the build dependency graph. By removing and fixing dependencies, we remove unneeded edges in the build graph. This in turn provides improved build parallelism and better avoidance in Skippy CI pipelines.</p> <p>A secondary benefit is automatic upkeep of build files. As projects change over time, dependencies become obsolete and out of date. Most developers do not keep up with these changes over time, so automating this affords us extra upkeep that we currently do not do.</p>"},{"location":"dependency-rake/#implementation","title":"Implementation","text":"<p>The core implementation of DR lives in <code>DependencyRake.kt</code>.</p>"},{"location":"dependency-rake/#usage","title":"Usage","text":"<p>To run dependency rake in a project, use the below command</p> <pre><code>$ ./gradlew rakeDependencies -Pslack.gradle.config.enableAnalysisPlugin=true --no-configuration-cache\n</code></pre> <p>This will run all <code>rakeDependencies</code> tasks in the project. This task exists on all subprojects as well, but it  works best if all are run together.</p> <p>Sometimes dependency rake will try to replace identifiers with ones that are not present in any available version catalogs. Sometimes this is acceptable, but often times it can result in \u201cmissing\u201d dependencies from  the build after it runs. To help fix these, DR will write all missing identifiers out to a build output file.</p> <p>For convenience, you can also run <code>./gradlew aggregateMissingIdentifiers -Pslack.gradle.config.enableAnalysisPlugin=true --no-configuration-cache</code> to run all dependency rake tasks and aggregate these missing identifiers into a root project build output file.</p>"},{"location":"dsl/","title":"DSL","text":"<p>SGP offers a DSL extension for configuring project behavior via the plugin. The idea is that developers don\u2019t really want to think about specific dependency wirings, and instead want to express what features they want and allow SGP to automatically wire these up for them.</p> <p>Some examples of this include Dagger, Moshi code gen, Robolectric, and more.</p> <p>The primary entry point is the <code>slack</code> extension in the build file, which is backed by the <code>SlackExtension</code> interface.</p> <pre><code>slack {\nfeatures {\ndagger(...)\nmoshi(...)\n}\nandroid {\nfeatures {\nrobolectric(...)\n}\n}\n}\n</code></pre>"},{"location":"dsl/#features","title":"Features","text":""},{"location":"dsl/#dagger","title":"Dagger","text":"<p>The Dagger feature automatically sets up both Dagger and Anvil. This includes optional parameters to control whether or not you want the runtime only, component merging, or other features. This automatically handles applying the Anvil, kapt, or KSP plugins under the hood and any necessary dependencies to run them.</p> <p>The default <code>dagger()</code> call will just enable Dagger\u2019s runtime + Anvil\u2019s factory generation with no component merging ( to avoid the Kapt cost).</p>"},{"location":"dsl/#moshi","title":"Moshi","text":"<p>The Moshi feature handles setting up both Moshi and MoshiX. This includes handling applying code gen logic (either KSP or IR) as well as <code>moshi-sealed</code> support if requested.</p>"},{"location":"dsl/#redacted","title":"Redacted","text":"<p>This enables the redacted-compiler-plugin compiler plugin.</p>"},{"location":"dsl/#compose","title":"Compose","text":"<p>The Compose feature handles setting up Compose in both Android and multiplatform projects. This handles a bunch of boilerplate (see <code>ComposeUtil.kt</code>) for applying the right compose-compiler artifact version as well as enabling the right controls in the Android plugin.</p>"},{"location":"dsl/#android-features","title":"Android Features","text":""},{"location":"dsl/#robolectric","title":"Robolectric","text":"<p>The Robolectric feature handles setting up Robolectric in an Android project. This entails common Robolectric dependencies (including any bundles or core Robolectric project dependencies). This also sets up Robolectric jar downloads (via <code>UpdateRobolectricJarsTask</code>) for test tasks and enabling resource merging in tests (which Robolectric requires). There are a few other controls that <code>StandardProjectConfigurations</code> use to control or patch Robolectric\u2019s behavior.</p>"},{"location":"dsl/#android-test","title":"Android Test","text":"<p>By default, SGP disables androidTests in projects. These can be enabled via the <code>androidTest()</code> feature, which will enable the relevant controls in the Android plugin. This can also accept specified variants to enable/disable.</p> <p>This is important for opting in tests to AndroidTest APK Aggregation.</p>"},{"location":"dsl/#resources","title":"Resources","text":"<p>By default, we disable Android resources (different from Java resources) and libraries have to opt-in to using them.</p> <p>This can be enabled via the <code>resources()</code> feature, which will enable the relevant <code>BuildFeature</code> in the Android plugin and also takes a required <code>prefix</code> parameter that is used as the required <code>resourcePrefix</code> for that library\u2019s resources to avoid naming conflicts.</p>"},{"location":"dsl/#android-application-features","title":"Android Application Features","text":""},{"location":"dsl/#permission-allowlist","title":"Permission AllowList","text":"<p>This enables checking of a permission allowlist. See <code>PermissionChecks</code> for more details.</p>"},{"location":"formatters-and-analysis/","title":"Formatters and Static Analysis","text":"<p>SGP supports running a number of formatters and static analysis tools.</p> <p>Individual tools are usually gated on whether they have a version specified in <code>libs.versions.toml</code>. If they do not have a version specified, they are deemed not enabled.</p>"},{"location":"formatters-and-analysis/#formatting","title":"Formatting","text":"<p>The core set of formatters are:</p> <ul> <li>ktfmt (Kotlin)</li> <li>google-java-format (Java)</li> <li>gson (JSON)</li> <li>gradle-dependency-sorter (Gradle build file dependencies)</li> <li>Spotless (general purpose Gradle plugin that runs most of the above)</li> </ul>"},{"location":"formatters-and-analysis/#static-analysis","title":"Static Analysis","text":"<p>The core set of analysis tools supported in SGP are:</p> <ul> <li>Android Lint (Kotlin, Java, XML resources, build files, etc.)</li> <li>Detekt (Kotlin)</li> <li>Error Prone (Java)</li> </ul>"},{"location":"formatters-and-analysis/#git-hooks","title":"Git Hooks","text":"<p>SGP ships with a standard set of git hooks (pre-commit, etc) that it can bootstrap in projects by running <code>./gradlew installCommitHooks</code>. These hooks rely on checking in relevant binaries for each formatter/checker, it\u2019s strongly recommended to use git-lfs for these. These files should be edited as needed to best serve the project they\u2019re running in.</p> <p>SGP can configure these hooks in the project automatically during bootstrap if you add the <code>slack.git.hooksPath</code> gradle property and point it at the hooks directory that the above command output to, or wherever the host project opts to store them.</p> <p>Note that Detekt is not yet supported in git hooks as these require extra parameters for baselines.</p>"},{"location":"formatters-and-analysis/#downloading-binaries","title":"Downloading binaries","text":"<p>Each tool (ktfmt, gjf, etc) has corresponding <code>./gradlew update&lt;tool name&gt;</code> tasks that you can run to download and install them, by default to <code>config/bin/&lt;tool name&gt;</code>. You should re-run these any time you update a tool to re-run them.</p>"},{"location":"lint/","title":"Lint","text":"<p>TODO</p>"},{"location":"mod-score/","title":"Mod Score","text":"<p>TODO</p>"},{"location":"properties/","title":"Properties","text":"<p>TODO</p>"},{"location":"skippy/","title":"Skippy","text":"<p>TODO</p>"},{"location":"testing/","title":"Testing","text":"<p>TODO</p>"},{"location":"thermals-logging/","title":"Thermals Logging","text":"<p>TODO</p>"},{"location":"utilities/","title":"Utilities","text":"<p>There are a bunch of miscellaneous utilities and tools in this project that don\u2019t necessarily warrant their own dedicated docs page.</p>"},{"location":"utilities/#androidsourcesconfigurer","title":"<code>AndroidSourcesConfigurer</code>","text":"<p>When testing new Android SDK betas, the compile SDK version is available months before sources are. Developers want to build against these APIs, but we don\u2019t want to make their experience in the IDE worse than necessary. The problem with using a compile SDK version that doesn\u2019t have sources is that the IDE can\u2019t provide any documentation for the APIs and will just show stub files instead.</p> <p>To work mitigate this, we will patch the SDK by putting a copy of the previous version\u2019s sources in the location of the new SDK. This allows most sources to still index properly during the beta period. Then, once the new sources are available, the consuming repo needs only to update the <code>slack.latestCompileSdkWithSources</code> gradle property to that new SDK version and the patcher will clear out that copy and let AGP download the real ones.</p> <p>This runs automatically in the root plugin.</p>"},{"location":"utilities/#androidtest-apk-aggregation","title":"AndroidTest APK Aggregation","text":"<p>At Slack we use FTL + Fladle for running our instrumentation tests. In order to add more test APKs from modularized instrumentation tests in other subprojects, we have to aggregate a list of their locations and pass them on to Fladle. This is done via <code>AndroidTestApksTask</code>, which is registered in the root project and can be wired to pipe its output file into Fladle\u2019s config input.</p> <p>Example</p> <pre><code>val aggregatedApksProvider = rootProject.tasks\n.named&lt;AndroidTestApksTask&gt;(\"aggregateAndroidTestApks\")\n.flatMap { it.outputFile }\n.map { it.asFile.readLines() }\n\ntasks\n.withType&lt;YamlConfigWriterTask&gt;()\n.matching { it.name == \"writeConfigProps${fladleTarget}\" }\n.configureEach { additionalTestApks.value(testInputsProvider) }\n</code></pre> <p>This task is automatically added to whenever a subproject uses the <code>androidTest()</code> DSL feature.</p>"},{"location":"utilities/#permissionchecks","title":"<code>PermissionChecks</code>","text":"<p>Permissions are an integral part of Android apps, and oversight into what permissions are required in the app is critical to a release pipeline. <code>PermissionChecks</code> is a feature to help with this.</p> <p>The workflow we use at Slack is like this:</p> <ul> <li>We check in a <code>permissionsAllowlist.txt</code> file in the Slack android repo.</li> <li>This file is owned in GitHub by a specific codeowner rule that adds a permission reviewers group.</li> <li>This file is passed into the <code>allowListFile</code> DSL feature in the application   project.</li> <li>On each build, SGP automatically checks that the permissions present in the release APK manifest match the ones   defined in the allowlist.</li> </ul> <p>This way new permissions are not accidentally or secretly added to the app.</p>"}]}
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 04f2465a625e314bb61e9d9b1fb19a3f272955dd..34764cb43ecd4a0e4620d7756dcb731c68e724c7 100644
GIT binary patch
delta 14
Vcmcb>c!7~kzMF$%ZTdvEQvf301lRxo

delta 14
Vcmcb>c!7~kzMF$%is?kQQve~F1dRXy