0Pricing
Groovy & Gradle: JVM Automation and Build Engineering · Lezione

Applicazione e pubblicazione dei plugin

Impari ad applicare plugin personalizzati ai progetti e a pubblicarli in un repository locale o remoto.

Applicazione e pubblicazione dei plugin è una lezione Groovy & Gradle: JVM Automation and Build Engineering gratuita su CoddyKit. Questa è la lezione 3 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Groovy & Gradle: JVM Automation and Build Engineering, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Groovy & Gradle: JVM Automation and Build Engineering include 4 lezioni in totale.

Parti di questa lezione non sono ancora state tradotte e vengono mostrate in inglese.

Reusing Your Gradle Plugins

So you've learned to create custom Gradle plugins. Great! But how do you actually use them in different projects, and how can you share them with others?

This lesson explores how to apply your custom plugins to a Gradle project and how to publish them to a local or remote repository for wider use.

Plugin Application Review

Before diving into custom plugins, let's quickly recall how you apply standard plugins.

  • Most plugins are applied using the plugins { id 'plugin-id' } block in your build.gradle file.
  • This method is preferred for its declarative nature and better tooling support.
  • It works for plugins from Gradle Plugin Portal, local buildSrc plugins, and published plugins.

Applying Script Plugins

You can define build logic directly within your build.gradle or include it from another script. This is the simplest form of reusing logic.

Below, a custom task myCustomTask is defined. It's available to your build script just like any other task.

task myCustomTask {
    doLast {
        println "Hello from my custom task!"
    }
}

task executeMyTask {
    dependsOn myCustomTask
    doLast {
        println "Main build script finished after custom task."
    }
}
// To run: gradle executeMyTask

Plugins from buildSrc

For more complex, project-specific plugins, Gradle automatically compiles and makes available any plugins defined in the buildSrc directory.

If you create a plugin in buildSrc/src/main/groovy/com/example/MyPlugin.groovy, it can be applied directly by its ID:

  • Define plugin: buildSrc/src/main/groovy/my.project.plugin.gradle
  • Apply plugin: plugins { id 'my.project.plugin' }

Gradle ensures buildSrc is built before your main project, making its plugins ready for use.

Why Publish Plugins?

While buildSrc is great for single-project or monorepo plugins, what if you want to share your plugin across completely separate projects, or even with the community?

This is where publishing comes in. Publishing makes your plugin available in a repository, just like any other library you use (e.g., from Maven Central).

  • Local: Share within your machine for personal use.
  • Remote: Share within your organization (Artifactory, Nexus) or globally (Gradle Plugin Portal, Maven Central).

Publishing with maven-publish

Gradle's maven-publish plugin is the standard way to publish your plugin artifacts to Maven-compatible repositories.

By applying this plugin, you gain access to a publishing block in your build.gradle, where you'll define the details of what gets published and how.

It also introduces tasks like publishToMavenLocal and publish.

plugins {
    id 'java-library' // Or 'groovy' for Groovy plugins
    id 'maven-publish'
}

group = 'com.coddykit.example'
version = '1.0.0'

// Applying maven-publish plugin
// This is part of setting up for publication.
// No direct output from this snippet alone.

Defining Publication Details

Inside the publishing block, you configure the details of your artifact: its name, what components to include (like JARs), and where it should go.

A "publication" defines a set of artifacts and their metadata (group, artifact ID, version).

plugins {
    id 'java-library'
    id 'maven-publish'
}

group = 'com.coddykit.example'
version = '1.0.0'

publishing {
    publications {
        maven(MavenPublication) {
            // The artifact ID is usually derived from project name,
            // but can be explicitly set.
            artifactId 'my-groovy-plugin'
            from components.java // Publish the Java library component
        }
    }
}
// This defines how the plugin will be published.
// No direct output from this snippet alone.

Publishing to Maven Local

After configuring your publication, you can publish your plugin to your local Maven repository. This is great for local testing and development.

Gradle provides a task for each publication you define (e.g., publishMavenPublicationToMavenLocal if your publication is named maven).

plugins {
    id 'java-library'
    id 'maven-publish'
}

group = 'com.coddykit.example'
version = '1.0.0'

publishing {
    publications {
        maven(MavenPublication) { // 'maven' is the publication name
            artifactId 'my-groovy-plugin'
            from components.java
        }
    }
    repositories {
        mavenLocal() // Explicitly declare mavenLocal for publishing
    }
}
// To publish: gradle publishMavenPublicationToMavenLocal
// This command will build your plugin and place its artifacts
// into your local Maven cache (~/.m2/repository).

Applying a Published Plugin

To use a plugin you've published to mavenLocal() in another project, you need two things:

  1. Declare mavenLocal(): Add mavenLocal() to the pluginManagement.repositories block in your consuming project's settings.gradle.
  2. Apply by ID and Version: Use the plugins { id '...' version '...' } block in your consuming project's build.gradle.

This tells Gradle to look for the plugin in your local Maven repository.

// settings.gradle (consuming project)
pluginManagement {
    repositories {
        mavenLocal()
        gradlePluginPortal()
    }
}

// build.gradle (consuming project)
plugins {
    id 'com.coddykit.example.my-groovy-plugin' version '1.0.0'
    // Replace 'com.coddykit.example.my-groovy-plugin' with your plugin's actual ID
}

// This code snippet shows how to apply a published plugin.
// It assumes the plugin has been published and is available locally.

Publishing Remotely

To share your plugin beyond your local machine, you publish it to a remote repository. This could be:

  • Company Artifactory/Nexus: For internal team use.
  • Gradle Plugin Portal: For public plugins, requiring the com.gradle.plugin-publish plugin.
  • Maven Central: The largest public repository.

The configuration in the publishing.repositories block specifies the URL and credentials for these remote destinations.

plugins {
    id 'maven-publish'
    // id 'com.gradle.plugin-publish' // For Gradle Plugin Portal
}

publishing {
    publications {
        maven(MavenPublication) { /* ... */ }
    }
    repositories {
        maven {
            name = "myCompanyRepo"
            url = uri("https://your.company.repo/releases")
            credentials {
                username = project.properties.get("repoUsername")
                password = project.properties.get("repoPassword")
            }
        }
    }
}
// This snippet shows how to define a remote repository.
// Credentials should be managed securely, not hardcoded.

Plugin Application Check

Time to test your understanding of applying and publishing plugins.

Recap: Apply & Publish

You've learned how to make your custom Gradle plugins truly reusable!

  • You can apply simple script plugins using apply from:.
  • Plugins in buildSrc are automatically available by ID.
  • The maven-publish plugin allows you to define and publish your plugin artifacts.
  • Publishing to mavenLocal() is great for local testing.
  • To use a published plugin, configure mavenLocal() in settings.gradle and apply it by ID and version.
  • Remote repositories enable sharing plugins across teams or publicly.

Now you can build powerful, shareable build logic!

Domande Frequenti

La lezione «Applicazione e pubblicazione dei plugin» è gratuita?

Sì — il testo completo di «Applicazione e pubblicazione dei plugin» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Groovy & Gradle: JVM Automation and Build Engineering, passa a CoddyKit PRO. Il corso Groovy & Gradle: JVM Automation and Build Engineering include 4 lezioni in totale.

Cosa imparerò in «Applicazione e pubblicazione dei plugin»?

Impari ad applicare plugin personalizzati ai progetti e a pubblicarli in un repository locale o remoto. Eserciti Groovy & Gradle: JVM Automation and Build Engineering con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Groovy & Gradle: JVM Automation and Build Engineering?

Non è richiesta alcuna esperienza precedente. Groovy & Gradle: JVM Automation and Build Engineering su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 3 di 4.

Quanto tempo richiede la lezione «Applicazione e pubblicazione dei plugin»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Groovy & Gradle: JVM Automation and Build Engineering?

Sì. Ogni lezione Groovy & Gradle: JVM Automation and Build Engineering include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

  1. Comprendere i plugin Gradle
  2. Creazione di plugin binari
  3. Applicazione e pubblicazione dei plugin
  4. Estensioni dei plugin e DSL configurabili
← Torna a Groovy & Gradle: JVM Automation and Build Engineering