aboutsummaryrefslogtreecommitdiff
path: root/build-logic/README.md
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-11-10 11:46:54 +0100
committerGitHub <noreply@github.com>2023-11-10 11:46:54 +0100
commit8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch)
tree1b915207b2b9f61951ddbf0ff2e687efd053d555 /build-logic/README.md
parenta44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff)
downloaddokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip
Restructure the project to utilize included builds (#3174)
* Refactor and simplify artifact publishing * Update Gradle to 8.4 * Refactor and simplify convention plugins and build scripts Fixes #3132 --------- Co-authored-by: Adam <897017+aSemy@users.noreply.github.com> Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
Diffstat (limited to 'build-logic/README.md')
-rw-r--r--build-logic/README.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/build-logic/README.md b/build-logic/README.md
index e8d18cbd..884eb582 100644
--- a/build-logic/README.md
+++ b/build-logic/README.md
@@ -1,7 +1,18 @@
-# About build-logic Module
+# build-logic
-This module aims to share common build logic for whole projects, previously we were using [buildSrc](https://docs.gradle.org/7.6/userguide/organizing_gradle_projects.html#sec:build_sources),
-but for some reasons like "A change in buildSrc causes the whole project to become out-of-date", we are migrating to [composite builds](https://docs.gradle.org/7.6/userguide/composite_builds.html),
-which avoids the side effects of buildSrc.
+This project aims to share common build logic between subprojects.
-For more information, you can ref https://proandroiddev.com/stop-using-gradle-buildsrc-use-composite-builds-instead-3c38ac7a2ab3. \ No newline at end of file
+In principle, this is similar to `buildSrc`, but this project utilizes [composite builds][1] to avoid various
+[inconvenient side effects][2] of `buildSrc`.
+
+For more information, see [Sharing Build Logic between Subprojects][3]
+
+___
+
+Note: the filename pattern used for convention plugins is inspired by how Gradle configures its
+own convention plugins; [example project here][4].
+
+[1]: https://docs.gradle.org/7.6/userguide/composite_builds.html
+[2]: https://proandroiddev.com/stop-using-gradle-buildsrc-use-composite-builds-instead-3c38ac7a2ab3
+[3]: https://docs.gradle.org/8.4/userguide/sharing_build_logic_between_subprojects.html
+[4]: https://github.com/gradle/gradle/tree/b165da7de15e70afb6cac564bf4aadf16aa157b3/build-logic/jvm/src/main/kotlin