You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 4, 2025. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+2-9
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Android Dependency Catalog
2
2
3
-
This project is a shared Android dependency catalog for Automattic projects which uses [Gradle's version catalog feature](https://docs.gradle.org/current/userguide/platforms.html). It's also used for generating a dependency cache that we use in our CIs to speed up our builds.
3
+
This project is a shared Android dependency catalog for Automattic projects which uses [Gradle's version catalog feature](https://docs.gradle.org/current/userguide/platforms.html).
4
4
5
5
## Table of Contents
6
6
@@ -10,7 +10,6 @@ This project is a shared Android dependency catalog for Automattic projects whic
10
10
*[Releasing a new catalog version](#releasing-a-new-catalog-version)
11
11
*[Naming conventions](#naming-conventions)
12
12
*[Building locally](#building-locally)
13
-
*[Dependency caching](#dependency-caching)
14
13
*[Automatically updating dependency versions in the catalog](#automatically-updating-dependency-versions-in-the-catalog)
15
14
*[Setting up your projects to automatically update the catalog version](#setting-up-your-projects-to-automatically-update-the-catalog-version)
16
15
@@ -61,7 +60,7 @@ See [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.h
*`version.ref` refers to the version name from `[versions]` section in the [libs.versions.toml](libs.versions.toml) file
64
-
* If this is a new plugin, add it under `plugins` section in [example/build.gradle.kts](example/build.gradle.kts) - make sure to add `.apply(false)`. This step is necessary because we use the `example` module to generate a dependency cache we use to speed up CI in other projects. We are able to automatically add the library dependencies, so this step is not necessary, but plugins need to be added manually.
63
+
* If this is a new plugin, add it under `plugins` section in [example/build.gradle.kts](example/build.gradle.kts) - make sure to add `.apply(false)`. We are able to automatically add the library dependencies, so this step is not necessary, but plugins need to be added manually.
65
64
*[Build the catalog & example projects](#building-locally) - if you get `Could not find {dependency}` error, make sure the repository for the new dependency you've added is included in [example/settings.gradle.kts](example/settings.gradle.kts)
66
65
* Follow the instructions for [releasing a new catalog version](#releasing-a-new-catalog-version)
67
66
@@ -93,12 +92,6 @@ We'll need to iterate on our naming conventions, but here are some general guide
93
92
94
93
**Note that `example` project does NOT use the generated version catalog from the `catalog` project.** Although this is not likely to cause a difference in practice, it's an important distinction to be aware of.
95
94
96
-
## Dependency caching
97
-
98
-
We use the `example` project to generate a dependency cache which is uploaded to S3 by CI and then used in several projects.
99
-
100
-
Note that all libraries within the version catalog will be automatically added as a dependency to the `example` project, but the plugins need to be added manually.
101
-
102
95
## Automatically updating dependency versions in the catalog
0 commit comments