From 99169bbd5a734146b5648394098c0b70103cca83 Mon Sep 17 00:00:00 2001 From: Chris Arriola Date: Wed, 16 Jun 2021 16:39:54 -0700 Subject: [PATCH] chore: Rename maven artifact to com.google.android.libraries.mapsplatform.secrets-gradle-plugin (#23) * chore: Rename maven artifact to com.google.android.libraries.mapsplatform.secrets-gradle-plugin * Add note about maven coordinate change. * Prevent running release.yml --- .github/workflows/release.yml | 2 +- README.md | 29 ++++++++++-- build.gradle | 5 ++- sample-app/build.gradle.kts | 2 +- secrets-gradle-plugin/build.gradle.kts | 44 ++++++++++++++++--- .../secrets_gradle_plugin/Extensions.kt | 2 +- .../secrets_gradle_plugin/SecretsPlugin.kt | 2 +- .../SecretsPluginExtension.kt | 2 +- .../SecretsPluginTest.kt | 6 +-- 9 files changed, 76 insertions(+), 18 deletions(-) rename secrets-gradle-plugin/src/main/java/com/google/android/{ => libraries/mapsplatform}/secrets_gradle_plugin/Extensions.kt (97%) rename secrets-gradle-plugin/src/main/java/com/google/android/{ => libraries/mapsplatform}/secrets_gradle_plugin/SecretsPlugin.kt (98%) rename secrets-gradle-plugin/src/main/java/com/google/android/{ => libraries/mapsplatform}/secrets_gradle_plugin/SecretsPluginExtension.kt (94%) rename secrets-gradle-plugin/src/test/kotlin/com/google/android/{ => libraries/mapsplatform}/secrets_gradle_plugin/SecretsPluginTest.kt (96%) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 06a0871..3a3980a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,7 +15,7 @@ name: Release on: push: - branches: [ main ] + branches: [ ] workflow_dispatch: jobs: release: diff --git a/README.md b/README.md index f7c1bb0..76f9fbc 100644 --- a/README.md +++ b/README.md @@ -16,19 +16,42 @@ class and in the Android manifest file. ## Installation -In your app-level `build.gradle` file: +**NOTE**: Starting from v1.1.0, the maven coordinate of the plugin changed group ID to "com.google.android.libraries.mapsplatform.secrets-gradle-plugin" and artifact ID to "secrets-gradle-plugin" and is now being distributed via Google Maven (gMaven). You can still download previous versions of the plugin from Gradle's plugin portal, but new versions will now only be distributed through gMaven. + +1. In your project's root `build.gradle` file: + +Groovy: +```groovy +buildscript { + dependencies { + classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:1.1.0" + } +} +``` + +Kotlin: +```kotlin +buildscript { + dependencies { + classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:1.1.0") + } +} +``` + + +2. In your app-level `build.gradle` file: Groovy: ```groovy plugins { - id 'com.google.android.secrets-gradle-plugin' version '1.1.0' + id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' } ``` Kotlin: ```groovy plugins { - id("com.google.android.secrets-gradle-plugin") version "1.1.0" + id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") } ``` diff --git a/build.gradle b/build.gradle index 2f8387b..339c170 100644 --- a/build.gradle +++ b/build.gradle @@ -1,13 +1,14 @@ // Top-level build file where you can add configuration options common to all sub-projects/modules. buildscript { - ext.kotlin_version = "1.4.20" + ext.kotlin_version = "1.4.32" repositories { google() mavenCentral() } dependencies { - classpath "com.android.tools.build:gradle:4.1.1" + classpath "com.android.tools.build:gradle:4.1.3" classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:1.1.0" // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files diff --git a/sample-app/build.gradle.kts b/sample-app/build.gradle.kts index 8b33aa5..7ae9751 100644 --- a/sample-app/build.gradle.kts +++ b/sample-app/build.gradle.kts @@ -17,7 +17,7 @@ plugins { id("kotlin-android") // 1. Include the plugin - id("com.google.secrets_gradle_plugin") version "0.6" + id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin.secrets-gradle-plugin") } android { diff --git a/secrets-gradle-plugin/build.gradle.kts b/secrets-gradle-plugin/build.gradle.kts index 3138c13..81f4ed6 100644 --- a/secrets-gradle-plugin/build.gradle.kts +++ b/secrets-gradle-plugin/build.gradle.kts @@ -42,9 +42,9 @@ gradlePlugin { } pluginBundle { - website = "https://github.com/google/secrets-gradle-plugin" - vcsUrl = "https://github.com/google/secrets-gradle-plugin" - description = "A Gradle plugin for providing secrets securely to an Android project." + website = PluginInfo.url + vcsUrl = PluginInfo.url + description = PluginInfo.description version = PluginInfo.version (plugins) { @@ -61,6 +61,38 @@ publishing { group = PluginInfo.group artifactId = PluginInfo.artifactId version = PluginInfo.version + + pom { + name.set(PluginInfo.artifactId) + description.set(PluginInfo.description) + url.set(PluginInfo.url) + + scm { + connection.set("scm:git@github.com:google/secrets-gradle-plugin.git") + developerConnection.set("scm:git@github.com:google/secrets-gradle-plugin.git") + url.set(PluginInfo.url) + } + + licenses { + license { + name.set("The Apache Software License, Version 2.0") + url.set("http://www.apache.org/licenses/LICENSE-2.0.txt") + distribution.set("repo") + } + } + + organization { + name.set("Google Inc.") + url.set("https://developers.google.com/maps") + } + + + developers { + developer { + name.set("Google Inc.") + } + } + } } } repositories { @@ -69,9 +101,11 @@ publishing { } object PluginInfo { - const val group = "com.google.android" const val artifactId = "secrets-gradle-plugin" + const val description = "A Gradle plugin for providing secrets securely to an Android project." + const val group = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin" + const val implementationClass = "com.google.android.libraries.mapsplatform.secrets_gradle_plugin.SecretsPlugin" const val name = "secretsGradlePlugin" + const val url = "https://github.com/google/secrets-gradle-plugin" const val version = "1.1.0" - const val implementationClass = "com.google.android.secrets_gradle_plugin.SecretsPlugin" } diff --git a/secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/Extensions.kt b/secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/Extensions.kt similarity index 97% rename from secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/Extensions.kt rename to secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/Extensions.kt index fe048b2..e29572f 100644 --- a/secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/Extensions.kt +++ b/secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/Extensions.kt @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.android.secrets_gradle_plugin +package com.google.android.libraries.mapsplatform.secrets_gradle_plugin import com.android.build.gradle.AppExtension import com.android.build.gradle.LibraryExtension diff --git a/secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/SecretsPlugin.kt b/secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPlugin.kt similarity index 98% rename from secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/SecretsPlugin.kt rename to secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPlugin.kt index 5d17d04..bc26750 100644 --- a/secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/SecretsPlugin.kt +++ b/secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPlugin.kt @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.android.secrets_gradle_plugin +package com.google.android.libraries.mapsplatform.secrets_gradle_plugin import com.android.build.gradle.internal.core.InternalBaseVariant import org.gradle.api.Plugin diff --git a/secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/SecretsPluginExtension.kt b/secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPluginExtension.kt similarity index 94% rename from secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/SecretsPluginExtension.kt rename to secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPluginExtension.kt index 77109c1..6a59123 100644 --- a/secrets-gradle-plugin/src/main/java/com/google/android/secrets_gradle_plugin/SecretsPluginExtension.kt +++ b/secrets-gradle-plugin/src/main/java/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPluginExtension.kt @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.android.secrets_gradle_plugin +package com.google.android.libraries.mapsplatform.secrets_gradle_plugin /** * Configuration object for [SecretsPlugin]. diff --git a/secrets-gradle-plugin/src/test/kotlin/com/google/android/secrets_gradle_plugin/SecretsPluginTest.kt b/secrets-gradle-plugin/src/test/kotlin/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPluginTest.kt similarity index 96% rename from secrets-gradle-plugin/src/test/kotlin/com/google/android/secrets_gradle_plugin/SecretsPluginTest.kt rename to secrets-gradle-plugin/src/test/kotlin/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPluginTest.kt index 05baa30..c0572ac 100644 --- a/secrets-gradle-plugin/src/test/kotlin/com/google/android/secrets_gradle_plugin/SecretsPluginTest.kt +++ b/secrets-gradle-plugin/src/test/kotlin/com/google/android/libraries/mapsplatform/secrets_gradle_plugin/SecretsPluginTest.kt @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.android.secrets_gradle_plugin +package com.google.android.libraries.mapsplatform.secrets_gradle_plugin import com.android.build.gradle.internal.core.InternalBaseVariant import com.nhaarman.mockitokotlin2.doReturn @@ -57,7 +57,7 @@ class SecretsPluginTest { variant = mock() { on { mergedFlavor } doReturn flavor } - project.pluginManager.apply("com.google.android.secrets-gradle-plugin") + project.pluginManager.apply("com.google.android.libraries.mapsplatform.secrets-gradle-plugin.secrets-gradle-plugin") } @Test(expected = ProjectConfigurationException::class) @@ -163,4 +163,4 @@ class SecretsPluginTest { Assert.assertFalse(placeholders.containsKey(it)) } } -} \ No newline at end of file +}