Skip to content

Commit 0efc6c7

Browse files
daymxndaymxn
authored
Refactor PublishingPlugin (#4923)
* Refactor PublishingPlugin * Update workflows * Add missing copyright * Fix typo * Fix old package being used for exposing plugin * Fix bugs with missing kotlindoc + validatePomForRelease testing * Add publishAll task for smoke tests * Utilize kotlinx-serialization instead of homebrew * Reorder companion object placement
1 parent c2a50cf commit 0efc6c7

20 files changed

+560
-465
lines changed

‎.github/workflows/build-release-artifacts.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424

2525
- name: Perform gradle build
2626
run: |
27-
./gradlew firebasePublish -PpublishConfigFilePath=release.cfg -PpublishMode=RELEASE
27+
./gradlew firebasePublish
2828
2929
- name: Generate release notes
3030
run: |

‎.github/workflows/check-head-dependencies.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414

1515
- name: Perform gradle build
1616
run: |
17-
./gradlew checkHeadDependencies -PpublishConfigFilePath=release.cfg -PpublishMode=RELEASE
17+
./gradlew checkHeadDependencies

‎.github/workflows/create_releases.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
with:
4040
base: 'releases/${{ inputs.name }}'
4141
branch: 'releases/${{ inputs.name }}.release'
42-
add-paths: release.cfg,release_report.md
42+
add-paths: release.json,release_report.md
4343
title: '${{ inputs.name}} release'
4444
body: 'Auto-generated PR for release ${{ inputs.name}}'
4545
commit-message: 'Create release config for ${{ inputs.name }}'

‎.github/workflows/semver-check.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414

1515
- name: Perform gradle build
1616
run: |
17-
./gradlew semverCheckForRelease -PpublishConfigFilePath=release.cfg -PpublishMode=RELEASE
17+
./gradlew semverCheckForRelease

‎.github/workflows/validate-dependencies.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414

1515
- name: Perform gradle build
1616
run: |
17-
./gradlew validatePomForRelease -PpublishConfigFilePath=release.cfg -PpublishMode=RELEASE
17+
./gradlew validatePomForRelease

‎build.gradle‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
import com.google.firebase.gradle.plugins.license.LicenseResolverPlugin
16-
import com.google.firebase.gradle.MultiProjectReleasePlugin
17-
1815
buildscript {
1916
// TODO: remove once all sdks have migrated to version catalog
2017
ext.kotlinVersion = libs.versions.kotlin.get()
@@ -58,11 +55,10 @@ ext {
5855
protobufJavaUtilVersion = libs.versions.protobufjavautil.get()
5956
}
6057

61-
apply plugin: com.google.firebase.gradle.plugins.publish.PublishingPlugin
6258
apply plugin: com.google.firebase.gradle.plugins.ci.ContinuousIntegrationPlugin
6359
apply plugin: com.google.firebase.gradle.plugins.ci.SmokeTestsPlugin
6460

65-
apply plugin: MultiProjectReleasePlugin
61+
apply plugin: com.google.firebase.gradle.plugins.PublishingPlugin
6662

6763
firebaseContinuousIntegration {
6864
ignorePaths = [

‎buildSrc/build.gradle.kts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
plugins {
1616
id("com.ncorti.ktfmt.gradle") version "0.11.0"
1717
id("com.github.sherter.google-java-format") version "0.9"
18+
kotlin("plugin.serialization") version "1.7.10"
1819
`kotlin-dsl`
1920
}
2021

@@ -67,6 +68,7 @@ dependencies {
6768

6869
implementation("org.eclipse.jgit:org.eclipse.jgit:6.3.0.202209071007-r")
6970

71+
implementation(libs.kotlinx.serialization.json)
7072
implementation("com.google.code.gson:gson:2.8.9")
7173
implementation("com.android.tools.build:gradle:7.2.2")
7274
implementation("com.android.tools.build:builder-test-api:7.2.2")
@@ -90,7 +92,7 @@ gradlePlugin {
9092
}
9193
register("publishingPlugin") {
9294
id = "PublishingPlugin"
93-
implementationClass = "com.google.firebase.gradle.plugins.publish.PublishingPlugin"
95+
implementationClass = "com.google.firebase.gradle.plugins.PublishingPlugin"
9496
}
9597
register("firebaseLibraryPlugin") {
9698
id = "firebase-library"

‎buildSrc/src/main/java/com/google/firebase/gradle/MultiProjectReleasePlugin.java‎

Lines changed: 0 additions & 128 deletions
This file was deleted.

‎buildSrc/src/main/java/com/google/firebase/gradle/plugins/CheckHeadDependencies.kt‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,43 +20,45 @@ import org.gradle.api.provider.ListProperty
2020
import org.gradle.api.tasks.Input
2121
import org.gradle.api.tasks.TaskAction
2222

23+
/**
24+
* Validates that all project level dependencies are in the release.
25+
*
26+
* Any releasing library that has a project level dependency on another library invokes the release
27+
* of said dependent libary. This is checked via the [artifactId]
28+
* [FirebaseLibraryExtension.artifactId], so that the check is version agnostic.
29+
*
30+
* @throws GradleException if any project level dependencies are found that are not included in the
31+
* release
32+
*/
2333
abstract class CheckHeadDependencies : DefaultTask() {
2434
@get:Input abstract val projectsToPublish: ListProperty<FirebaseLibraryExtension>
2535

26-
@get:Input abstract val allFirebaseProjects: ListProperty<String>
27-
2836
@TaskAction
2937
fun run() {
30-
val projectsReleasing: Set<String> = projectsToPublish.get().map { it.artifactId.get() }.toSet()
38+
val projectsReleasing = computeProjectsReleasing()
39+
3140
val errors =
3241
projectsToPublish
3342
.get()
34-
.associate {
35-
it.artifactId.get() to
36-
it
37-
.projectDependenciesByName()
38-
.intersect(allFirebaseProjects.get())
39-
.subtract(projectsReleasing)
40-
.subtract(DEPENDENCIES_TO_IGNORE)
41-
}
43+
.associate { it.artifactId.get() to it.projectLevelDepsAsArtifactIds() - projectsReleasing }
4244
.filterValues { it.isNotEmpty() }
4345
.map { "${it.key} requires: ${it.value.joinToString(", ") }" }
4446

4547
if (errors.isNotEmpty()) {
4648
throw GradleException(
47-
"Project-level dependency errors found. Please update the release config.\n${
48-
errors.joinToString(
49-
"\n"
50-
)
51-
}"
49+
"Project-level dependency errors found. Please update the release config.\n" +
50+
"${errors.joinToString("\n")}"
5251
)
5352
}
5453
}
5554

56-
private fun FirebaseLibraryExtension.projectDependenciesByName() =
55+
private fun FirebaseLibraryExtension.projectLevelDepsAsArtifactIds() =
5756
resolveProjectLevelDependencies().map { it.artifactId.get() }
5857

58+
private fun computeProjectsReleasing() =
59+
projectsToPublish.get().map { it.artifactId.get() } + DEPENDENCIES_TO_IGNORE
60+
5961
companion object {
60-
val DEPENDENCIES_TO_IGNORE: List<String> = listOf("protolite-well-known-types")
62+
val DEPENDENCIES_TO_IGNORE = listOf("protolite-well-known-types")
6163
}
6264
}

‎buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ abstract class DackkaPlugin : Plugin<Project> {
134134

135135
kotlinDoc.configure {
136136
dependsOn(generateDocumentation, firesiteTransform, copyDocsToCommonDirectory)
137+
138+
outputs.dir(copyDocsToCommonDirectory.map { it.destinationDir })
137139
}
138140
}
139141
}

0 commit comments

Comments
 (0)