|
| 1 | +// Copyright 2021 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | +package com.google.firebase.gradle; |
| 15 | + |
| 16 | +import com.google.common.collect.ImmutableMap; |
| 17 | +import com.google.firebase.gradle.bomgenerator.BomGeneratorTask; |
| 18 | +import com.google.firebase.gradle.plugins.FirebaseLibraryExtension; |
| 19 | +import com.google.firebase.gradle.plugins.publish.PublishingPlugin; |
| 20 | +import java.util.Set; |
| 21 | +import java.util.stream.Collectors; |
| 22 | +import org.gradle.api.GradleException; |
| 23 | +import org.gradle.api.Plugin; |
| 24 | +import org.gradle.api.Project; |
| 25 | +import org.gradle.api.Task; |
| 26 | +import org.gradle.api.tasks.Copy; |
| 27 | +import org.gradle.api.tasks.TaskProvider; |
| 28 | +import org.gradle.api.tasks.bundling.Zip; |
| 29 | + |
| 30 | +/** |
| 31 | + * Orchestrates the release process by automating validations, documentation and prebuilts |
| 32 | + * generation. |
| 33 | + * |
| 34 | + * <ul> |
| 35 | + * <li>Pre-release validations: |
| 36 | + * <ul> |
| 37 | + * <li>Build maven artifacts. |
| 38 | + * </ul> |
| 39 | + * <li>Documentation: |
| 40 | + * <ul> |
| 41 | + * <li>Generates javadoc for all SDKs being released. |
| 42 | + * </ul> |
| 43 | + * <li>Artifact generation: |
| 44 | + * <ul> |
| 45 | + * <li>Releases artifacts into a maven repo in build/m2repository. |
| 46 | + * <li>Bundles all artifacts into a distributable .zip file. |
| 47 | + * </ul> |
| 48 | + * </ul> |
| 49 | + */ |
| 50 | +public class MultiProjectReleasePlugin implements Plugin<Project> { |
| 51 | + |
| 52 | + // TODO() - Will be removed once migrated to Kotlin |
| 53 | + private static String findStringProperty(Project p, String property) { |
| 54 | + Object value = p.findProperty(property); |
| 55 | + return value != null ? value.toString() : null; |
| 56 | + } |
| 57 | + |
| 58 | + @Override |
| 59 | + public void apply(Project project) { |
| 60 | + project.apply(ImmutableMap.of("plugin", PublishingPlugin.class)); |
| 61 | + |
| 62 | + project |
| 63 | + .getTasks() |
| 64 | + .create( |
| 65 | + "buildBomZip", |
| 66 | + Zip.class, |
| 67 | + task -> { |
| 68 | + task.dependsOn(project.getTasks().create("generateBom", BomGeneratorTask.class)); |
| 69 | + task.from("bom"); |
| 70 | + task.getArchiveFileName().set("bom.zip"); |
| 71 | + task.getDestinationDirectory().set(project.getRootDir()); |
| 72 | + }); |
| 73 | + |
| 74 | + TaskProvider<ReleaseGenerator> generatorTask = |
| 75 | + project |
| 76 | + .getTasks() |
| 77 | + .register( |
| 78 | + "makeReleaseConfigFiles", |
| 79 | + ReleaseGenerator.class, |
| 80 | + task -> { |
| 81 | + task.getCurrentRelease() |
| 82 | + .convention(findStringProperty(project, "currentRelease")); |
| 83 | + task.getPastRelease().convention(findStringProperty(project, "pastRelease")); |
| 84 | + task.getPrintReleaseConfig() |
| 85 | + .convention(findStringProperty(project, "printOutput")); |
| 86 | + task.getReleaseConfigFile() |
| 87 | + .convention(project.getLayout().getBuildDirectory().file("release.cfg")); |
| 88 | + task.getReleaseReportFile() |
| 89 | + .convention( |
| 90 | + project.getLayout().getBuildDirectory().file("release_report.md")); |
| 91 | + }); |
| 92 | + |
| 93 | + project |
| 94 | + .getTasks() |
| 95 | + .register( |
| 96 | + "generateReleaseConfig", |
| 97 | + Copy.class, |
| 98 | + task -> { |
| 99 | + task.from(generatorTask); |
| 100 | + task.into(project.getRootDir()); |
| 101 | + }); |
| 102 | + |
| 103 | + project |
| 104 | + .getGradle() |
| 105 | + .projectsEvaluated( |
| 106 | + gradle -> { |
| 107 | + Set<FirebaseLibraryExtension> librariesToPublish = |
| 108 | + (Set<FirebaseLibraryExtension>) |
| 109 | + project.getExtensions().getExtraProperties().get("projectsToPublish"); |
| 110 | + |
| 111 | + Set<Project> projectsToPublish = |
| 112 | + librariesToPublish.stream().map(lib -> lib.project).collect(Collectors.toSet()); |
| 113 | + |
| 114 | + Task validateProjectsToPublish = |
| 115 | + project.task( |
| 116 | + "validateProjectsToPublish", |
| 117 | + task -> |
| 118 | + task.doLast( |
| 119 | + t -> { |
| 120 | + if (projectsToPublish.isEmpty()) { |
| 121 | + throw new GradleException( |
| 122 | + "Required projectsToPublish parameter missing."); |
| 123 | + } |
| 124 | + })); |
| 125 | + project.getTasks().findByName("firebasePublish").dependsOn(validateProjectsToPublish); |
| 126 | + }); |
| 127 | + } |
| 128 | +} |
0 commit comments