Skip to content

Commit

Permalink
move marker to com.gradleup namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
martinbonnin committed Feb 19, 2024
1 parent 2259266 commit f061c22
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ Gratatouille enforces a clear separation between your plugin logic (**implementa

# Quick Start

## Step 1/2: `gratatouille.implementation`
## Step 1/2: `com.gradleup.gratatouille.implementation`

Create an `implementation` module for your plugin implementation and apply the `gratatouille.implementation` plugin:
Create an `implementation` module for your plugin implementation and apply the `com.gradleup.gratatouille.implementation` plugin:

```kotlin
// implementation/build.gradle.kts
plugins {
id("gratatouille.implementation")
id("com.gradleup.gratatouille.implementation")
}

dependencies {
Expand Down Expand Up @@ -62,18 +62,18 @@ Gratatouille automatically maps function parameters to Gradle inputs and the ret

Gratatouille generates entry points, task, workers and Gradle wiring code that can be used from your plugin.

## Step 2/2 `gratatouille.gradle.plugin`
## Step 2/2 `com.gradleup.gratatouille.plugin`

To use the generated code in your plugin, create a `gradle-plugin` module next to your `implementation` module.

By using two different modules, Gratatouille ensures that Gradle classes do not leak in your plugin implementation and vice-versa.

The `gradle-plugin` module should depend on the Gradle API and apply the `gratatouille.gradle.plugin`:
The `gradle-plugin` module should depend on the Gradle API and apply the `com.gradleup.gratatouille.plugin`:

```kotlin
// implementation/build.gradle.kts
plugins {
id("gratatouille.gradle.plugin")
id("com.gradleup.gratatouille.plugin")
}

dependencies {
Expand Down
8 changes: 4 additions & 4 deletions gratatouille-gradle-plugin/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ buildConfig {

gradlePlugin {
plugins {
create("gratatouille.implementation") {
create("com.gradleup.gratatouille.implementation") {
this.implementationClass = "gratatouille.gradle.GratatouilleImplementationPlugin"
this.id = "gratatouille.implementation"
this.id = "com.gradleup.gratatouille.implementation"
}
create("gratatouille.gradle.plugin") {
create("com.gradleup.gratatouille.plugin") {
this.implementationClass = "gratatouille.gradle.GratatouilleGradlePluginPlugin"
this.id = "gratatouille.gradle.plugin"
this.id = "com.gradleup.gratatouille.plugin"
}
}
}
2 changes: 1 addition & 1 deletion sample-plugin/gradle-plugin/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
plugins {
id("org.jetbrains.kotlin.jvm")
id("gratatouille.gradle.plugin")
id("com.gradleup.gratatouille.plugin")
id("java-gradle-plugin")
}

Expand Down
2 changes: 1 addition & 1 deletion sample-plugin/implementation/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ plugins {
id("org.jetbrains.kotlin.jvm")
id("org.jetbrains.kotlin.plugin.serialization")
id("com.google.devtools.ksp")
id("gratatouille.implementation")
id("com.gradleup.gratatouille.implementation")
}

dependencies {
Expand Down
2 changes: 1 addition & 1 deletion test-plugin/gradle-plugin/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
plugins {
id("org.jetbrains.kotlin.jvm")
id("gratatouille.gradle.plugin")
id("com.gradleup.gratatouille.plugin")
id("java-gradle-plugin")
}

Expand Down
2 changes: 1 addition & 1 deletion test-plugin/implementation/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ plugins {
id("org.jetbrains.kotlin.jvm")
id("org.jetbrains.kotlin.plugin.serialization")
id("com.google.devtools.ksp")
id("gratatouille.implementation")
id("com.gradleup.gratatouille.implementation")
}

dependencies {
Expand Down

0 comments on commit f061c22

Please sign in to comment.