https://github.com/hndrs/gradle-publishing-info-plugin

Gradle plugin that simplifies adding publishing info to your libraries
https://github.com/hndrs/gradle-publishing-info-plugin

gradle gradle-kotlin-dsl gradle-multi-project gradle-plugin gradle-publish kotlin maven maven-plugin maven-publish publishing

Last synced: 7 months ago
JSON representation

Gradle plugin that simplifies adding publishing info to your libraries

• Host: GitHub
• URL: https://github.com/hndrs/gradle-publishing-info-plugin
• Owner: hndrs
• License: mit
• Created: 2021-02-10T18:32:36.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-22T17:57:38.000Z (about 2 years ago)
• Last Synced: 2025-01-29T17:24:21.304Z (9 months ago)
• Topics: gradle, gradle-kotlin-dsl, gradle-multi-project, gradle-plugin, gradle-publish, kotlin, maven, maven-plugin, maven-publish, publishing
• Language: Kotlin
• Homepage:
• Size: 130 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Maven metadata URL](https://img.shields.io/maven-metadata/v?color=green&label=GRADLE%20PLUGIN&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Fio%2Fhndrs%2Fpublishing-info%2Fio.hndrs.publishing-info.gradle.plugin%2Fmaven-metadata.xml&style=for-the-badge)](https://plugins.gradle.org/plugin/io.hndrs.publishing-info)

[![Coverage](https://img.shields.io/sonar/coverage/hndrs_gradle-publishing-info-plugin?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/dashboard?id=hndrs_gradle-publishing-info-plugin)

[![Supported Java Version](https://img.shields.io/badge/Supported%20Java%20Version-17%2B-informational?style=for-the-badge)]()

[![Sponsor](https://img.shields.io/static/v1?logo=GitHub&label=Sponsor&message=%E2%9D%A4&color=ff69b4&style=for-the-badge)](https://github.com/sponsors/marvinschramm)

# Gradle Publishing Info

This is a small helper plugin to add meta information to maven publications.

## Using the Plugin

Add the following dependency to your plugin block in your rootProject

```kotlin

plugins {

    id("io.hndrs.publishing-info").version("3.1.0")

}

```

The Plugin automatically registers a ```publishingInfo``` extension on all projects

#### Configuring the RootProject

```kotlin

publishingInfo {

    name = "Root Project"

    description = "Sample RootProject Description"

    inceptionYear = "2021"

    url = "https://github.com/hndrs/gradle-publishing-info-plugin"

    license = License(

        "https://github.com/hndrs/gradle-publishing-info-plugin/blob/main/LICENSE",

        "MIT License"

    )

    developers = listOf(

        Developer("maintainerid", "Maintainers Name", "maintainer@email.com")

    )

    contributers = listOf(

        Contributor("Contributer Name", "contributers email")

    )

    organization = Organization("Your Org", "https://yourdomain.com")

    scm = Scm(

        "scm:git:git://github.com/hndrs/gradle-publishing-info-plugin",

        "https://github.com/hndrs/gradle-publishing-info-plugin"

    )

}

```

> RootProject gradle file (build.gradle.kts)

#### Configuring SubProjects

```kotlin

publishingInfo {

    // applies all values from rootProject publishingInfo block

    applyFromRoot = true

    // overrides name

    name = "Sub Project"

    // overrides description

    description = "Sample SubProject Description"

}

```