Loading local Kotlin Gradle plugin

Help/Discuss
1

I created a simple Kotlin Gradle plugin (using the standalone project Gradle plugin documentation). I cannot find the correct steps to load the fat jar locally into my test project instead of from a repository. I tried

// build.gradle.kts
buildscript {
    dependencies {
        classpath(files("/path/to/plugin-1.0-all.jar"))
    }
}

and I tried variations of

// settings.gradle.kts
pluginManagement {
    repositories {
        gradlePluginPortal()
        jcenter()
        flatDir {
            dirs("/path/to/plugin/dir")
        }
    }
}

and every scenario ends up with the following message:

Plugin [id: 'myplugin', version: '1.0'] was not found in any of the following sources:

- Gradle Core Plugins (plugin is not in 'org.gradle' namespace)
- Plugin Repositories (could not resolve plugin artifact 'myplugin:myplugin.gradle.plugin:1.0')
  Searched in the following repositories:
    Gradle Central Plugin Repository
    BintrayJCenter
    flatDir(/path/to/plugin/dir)
2

You want the „Automatic injection with the Java Gradle Plugin Development plugin“ section of the user guide.

Here’s the associated code.

3

This looks like a runner for testing the gradle pluign, which I have done and that works. Maybe I confused things by saying “test project”.

I’m wanting to load the Gradle plugin jar into a real project, but located locally on my computer.

4

Apologies. Do you want to apply the custom plugin you created? And exercise it in your „test project“?

Or do you only want to access the actual Jar file that the publish task generated? And do something with the actual Jar file that contains your custom plugin?

5

Rereading your reply more carefully, it sounds like you probably want this example instead.

1 Like
6

No worries. It was my mistake. I appreciate your time.

I was looking to load the gradle plugin that I made into my other project, but without publishing it to the Gradle Plugin Portal. Unless I’m wrong here and publishing it to the portal is the only way to add it to my project. So if my gradle plugin adds a task fancyNewTask, I want to add it to project foo and run the new fancyNewTask in that project.

7

Yeah, we both hit send at the same time :slight_smile:

That customPlugin example I posted above is the template I follow when I want to do what you described.

8

I got it working! Thanks. I used that example before. It looks like I mistakenly forgot:

In Gradle plugin project:

  • Add maven-publish

  • Add publishing block in build.gradle.kts

    publishing {
    repositories {
    maven {
    url = uri("$buildDir/repo")
    }
    }
    }

In my project that consumes/uses the plugin:

  • Add maven url block in buildscript block into build.gradle.kts

    buildscript {
    repositories {
    maven {
    // end::use-task
    // end::use-plugin
    val producerName = findProperty(“producerName”) ?: “plugin”
    val repoLocation = “…/$producerName/build/repo”
    // tag::use-plugin
    // tag::use-task
    url = uri(repoLocation)
    }
    }
    dependencies {
    classpath(“org.gradle:customPlugin:1.0-SNAPSHOT”)
    }
    }

  • Apply plugin:

apply(plugin = "org.samples.greeting")

Thanks again!

9

You bet :+1:

As an aside: This zip file contains an example of a custom plugin project that has the pluginManagement{} block in settings.gradle. I prefer that over Gradle’s stock example because it keeps the build.gradle script simpler in my opinion.

The stock Gradle sample project I linked to above is a multi-module-type structure. It has one project folder for the plugin and a second project for the user of the plugin.

The directory structure in my attached custom plugin project, on the other hand, is flat. There’s only a single project. I prefer this simpler structure for doing quick and dirty experiments and proofs of concept.

But there are two build scripts in my example. One to build and install the custom plugin. And a second script that consumes the plugin.

To consume the plugin, I pass Gradle the name of the consumer build script explicitly: gradle --build-file=use.plugin.gradle myTask.

10

Awesome! Thanks for the tip and guidance.

11

This link is no longer available, any chance you have the new one?

12

Probably this one: Gradle Plugin Sample

13

Ah thanks… I am basically trying to implement a custom version of this plugin exposed-intellij-plugin/exposed-gradle-plugin at master · JetBrains/exposed-intellij-plugin · GitHub

Because it doesn’t work with TimescaleDB. Just trying to figure out the easiest way to load it in my project.

14

You are probably after Composite Builds