Skip to content

Commit

Permalink
Migrate buildSrc to composite build (#2912)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Goooler
Goooler committed Mar 13, 2023
1 parent 7a46cd3 commit 3ea4142
Show file tree
Hide file tree
Showing 47 changed files with 66 additions and 59 deletions.
7 changes: 7 additions & 0 deletions build-logic/README.md
View file
@@ -0,0 +1,7 @@
# About build-logic Module

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.

For more information, you can ref https://proandroiddev.com/stop-using-gradle-buildsrc-use-composite-builds-instead-3c38ac7a2ab3.
1 change: 0 additions & 1 deletion buildSrc/build.gradle.kts → build-logic/build.gradle.kts
View file
Expand Up @@ -28,5 +28,4 @@ dependencies {
implementation("org.jetbrains.kotlinx:binary-compatibility-validator:0.12.1")
implementation("io.github.gradle-nexus:publish-plugin:1.1.0")
implementation("org.jetbrains.dokka:dokka-gradle-plugin:1.8.10")
implementation("com.gradle.publish:plugin-publish-plugin:0.20.0")
}
2 changes: 1 addition & 1 deletion buildSrc/settings.gradle.kts → build-logic/settings.gradle.kts
View file
@@ -1,4 +1,4 @@
rootProject.name = "buildSrc"
rootProject.name = "build-logic"

pluginManagement {
repositories {
Expand Down
0 ...kotlin/org/jetbrains/CrossPlatformExec.kt → ...kotlin/org/jetbrains/CrossPlatformExec.kt
View file
File renamed without changes.
0 .../org/jetbrains/DokkaPublicationChannel.kt → .../org/jetbrains/DokkaPublicationChannel.kt
View file
File renamed without changes.
0 ...main/kotlin/org/jetbrains/DokkaVersion.kt → ...main/kotlin/org/jetbrains/DokkaVersion.kt
View file
File renamed without changes.
0 .../kotlin/org/jetbrains/DokkaVersionType.kt → .../kotlin/org/jetbrains/DokkaVersionType.kt
View file
File renamed without changes.
0 ...c/main/kotlin/org/jetbrains/SetupMaven.kt → ...c/main/kotlin/org/jetbrains/SetupMaven.kt
View file
File renamed without changes.
0 ...lin/org/jetbrains/ValidatePublications.kt → ...lin/org/jetbrains/ValidatePublications.kt
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion ...etbrains/conventions/base-java.gradle.kts → ...etbrains/conventions/base-java.gradle.kts
View file
Expand Up @@ -8,7 +8,7 @@ package org.jetbrains.conventions
*/

plugins {
`java`
java
}

java {
Expand Down
0 ...org/jetbrains/conventions/base.gradle.kts → ...org/jetbrains/conventions/base.gradle.kts
View file
File renamed without changes.
6 changes: 3 additions & 3 deletions ...entions/dokka-integration-test.gradle.kts → ...entions/dokka-integration-test.gradle.kts
View file
Expand Up @@ -7,16 +7,16 @@ plugins {
id("org.jetbrains.conventions.kotlin-jvm")
}

val integrationTestSourceSet = sourceSets.create("integrationTest") {
val integrationTestSourceSet: SourceSet = sourceSets.create("integrationTest") {
compileClasspath += sourceSets.main.get().output
runtimeClasspath += sourceSets.main.get().output
}

val integrationTestImplementation by configurations.getting {
val integrationTestImplementation: Configuration by configurations.getting {
extendsFrom(configurations.implementation.get())
}

val integrationTestRuntimeOnly by configurations.getting {
val integrationTestRuntimeOnly: Configuration by configurations.getting {
extendsFrom(configurations.runtimeOnly.get())
}

Expand Down
0 ...rg/jetbrains/conventions/dokka.gradle.kts → ...rg/jetbrains/conventions/dokka.gradle.kts
View file
File renamed without changes.
0 ...tbrains/conventions/kotlin-jvm.gradle.kts → ...tbrains/conventions/kotlin-jvm.gradle.kts
View file
File renamed without changes.
0 ...ains/conventions/maven-publish.gradle.kts → ...ains/conventions/maven-publish.gradle.kts
View file
File renamed without changes.
0 ...main/kotlin/org/jetbrains/projectUtils.kt → ...main/kotlin/org/jetbrains/projectUtils.kt
View file
File renamed without changes.
0 .../main/kotlin/org/jetbrains/publication.kt → .../main/kotlin/org/jetbrains/publication.kt
View file
File renamed without changes.
0 ...rc/main/kotlin/org/jetbrains/taskUtils.kt → ...rc/main/kotlin/org/jetbrains/taskUtils.kt
View file
File renamed without changes.
10 changes: 5 additions & 5 deletions build.gradle.kts
View file
Expand Up @@ -2,11 +2,11 @@ import org.jetbrains.ValidatePublications
import org.jetbrains.publicationChannels

plugins {
org.jetbrains.conventions.base
id("org.jetbrains.dokka")
id("io.github.gradle-nexus.publish-plugin")

id("org.jetbrains.kotlinx.binary-compatibility-validator")
id("org.jetbrains.conventions.base") apply false
id("org.jetbrains.dokka") version "1.8.10"
id("io.github.gradle-nexus.publish-plugin") version "1.1.0"
id("com.gradle.plugin-publish") version "0.20.0"
id("org.jetbrains.kotlinx.binary-compatibility-validator") version "0.12.1"
}

val dokka_version: String by project
Expand Down
4 changes: 2 additions & 2 deletions core/build.gradle.kts
View file
Expand Up @@ -2,8 +2,8 @@ import org.jetbrains.dokkaVersion
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
2 changes: 1 addition & 1 deletion core/content-matcher-test-utils/build.gradle.kts
View file
@@ -1,5 +1,5 @@
plugins {
org.jetbrains.conventions.`kotlin-jvm`
id("org.jetbrains.conventions.kotlin-jvm")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions core/test-api/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
2 changes: 1 addition & 1 deletion integration-tests/build.gradle.kts
View file
@@ -1,5 +1,5 @@
plugins {
org.jetbrains.conventions.`kotlin-jvm`
id("org.jetbrains.conventions.kotlin-jvm")
}

dependencies {
Expand Down
2 changes: 1 addition & 1 deletion integration-tests/cli/build.gradle.kts
View file
@@ -1,7 +1,7 @@
import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar

plugins {
org.jetbrains.conventions.`dokka-integration-test`
id("org.jetbrains.conventions.dokka-integration-test")
id("com.github.johnrengelman.shadow")
}

Expand Down
2 changes: 1 addition & 1 deletion integration-tests/gradle/build.gradle.kts
View file
@@ -1,7 +1,7 @@
import org.jetbrains.dependsOnMavenLocalPublication

plugins {
org.jetbrains.conventions.`dokka-integration-test`
id("org.jetbrains.conventions.dokka-integration-test")
}

dependencies {
Expand Down
2 changes: 1 addition & 1 deletion integration-tests/maven/build.gradle.kts
View file
Expand Up @@ -2,7 +2,7 @@ import org.jetbrains.SetupMaven
import org.jetbrains.dependsOnMavenLocalPublication

plugins {
org.jetbrains.conventions.`dokka-integration-test`
id("org.jetbrains.conventions.dokka-integration-test")
}

evaluationDependsOn(":runners:maven-plugin")
Expand Down
4 changes: 2 additions & 2 deletions kotlin-analysis/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
id("com.github.johnrengelman.shadow")
}

Expand Down
4 changes: 2 additions & 2 deletions kotlin-analysis/compiler-dependency/build.gradle.kts
View file
Expand Up @@ -2,8 +2,8 @@ import org.jetbrains.DokkaPublicationBuilder.Component.Shadow
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
id("com.github.johnrengelman.shadow")
}

Expand Down
4 changes: 2 additions & 2 deletions kotlin-analysis/intellij-dependency/build.gradle.kts
View file
Expand Up @@ -2,8 +2,8 @@ import org.jetbrains.DokkaPublicationBuilder.Component.Shadow
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
id("com.github.johnrengelman.shadow")
}

Expand Down
4 changes: 2 additions & 2 deletions plugins/all-modules-page/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

registerDokkaArtifactPublication("dokkaAllModulesPage") {
Expand Down
4 changes: 2 additions & 2 deletions plugins/android-documentation/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/base/base-test-utils/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/base/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/gfm/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/gfm/gfm-template-processing/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/javadoc/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/jekyll/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/jekyll/jekyll-template-processing/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/kotlin-as-java/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/mathjax/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

dependencies {
Expand Down
4 changes: 2 additions & 2 deletions plugins/templating/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

registerDokkaArtifactPublication("templating-plugin") {
Expand Down
4 changes: 2 additions & 2 deletions plugins/versioning/build.gradle.kts
View file
@@ -1,8 +1,8 @@
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

registerDokkaArtifactPublication("versioning-plugin") {
Expand Down
4 changes: 2 additions & 2 deletions runners/cli/build.gradle.kts
View file
Expand Up @@ -2,8 +2,8 @@ import org.jetbrains.DokkaPublicationBuilder.Component.Shadow
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
id("com.github.johnrengelman.shadow")
}

Expand Down
4 changes: 2 additions & 2 deletions runners/gradle-plugin/build.gradle.kts
View file
Expand Up @@ -2,8 +2,8 @@ import org.jetbrains.*

plugins {
`kotlin-dsl`
org.jetbrains.conventions.`maven-publish`
org.jetbrains.conventions.`base-java`
id("org.jetbrains.conventions.maven-publish")
id("org.jetbrains.conventions.base-java")
id("com.gradle.plugin-publish")
}

Expand Down
4 changes: 2 additions & 2 deletions runners/maven-plugin/build.gradle.kts
View file
Expand Up @@ -3,8 +3,8 @@ import org.jetbrains.SetupMaven
import org.jetbrains.registerDokkaArtifactPublication

plugins {
org.jetbrains.conventions.`kotlin-jvm`
org.jetbrains.conventions.`maven-publish`
id("org.jetbrains.conventions.kotlin-jvm")
id("org.jetbrains.conventions.maven-publish")
}

val setupMaven by tasks.register<SetupMaven>("setupMaven")
Expand Down
1 change: 1 addition & 0 deletions settings.gradle.kts
View file
Expand Up @@ -39,6 +39,7 @@ include(

":mkdocs",
)
includeBuild("build-logic")

val isCiBuild = System.getenv("GITHUB_ACTIONS") != null || System.getenv("TEAMCITY_VERSION") != null

Expand Down
2 changes: 1 addition & 1 deletion test-utils/build.gradle.kts
View file
@@ -1,5 +1,5 @@
plugins {
org.jetbrains.conventions.`kotlin-jvm`
id("org.jetbrains.conventions.kotlin-jvm")
}

dependencies {
Expand Down

0 comments on commit 3ea4142

Please sign in to comment.