Skip to content

Gradle plugin to ease defining project metadata (urls, license, scm)

License

Notifications You must be signed in to change notification settings

SgtSilvio/gradle-metadata

Repository files navigation

Metadata for Gradle Projects

Gradle Plugin Portal GitHub GitHub Workflow Status (with branch)

Gradle plugin to ease defining project metadata:

  • module name
  • readable name
  • url, docUrl
  • organization
  • license
  • developers
  • issue management
  • github

How to Use

plugins {
    id("io.github.sgtsilvio.gradle.metadata") version "0.6.0"
}

metadata {
    moduleName.set("org.example.library")
    readableName.set("Example library")
    license {
        apache2()
    }
    organization {
        name.set("Example Org")
        url.set("https://www.example.org")
    }
    developers {
        register("jdoe") {
            fullName.set("John Doe")
            email.set("john.doe@example.org")
        }
    }
    github {
        org.set("example")
        pages()
        issues()
    }
}

Requirements

  • Gradle 6.6 or higher

Integration with Other Plugins

  • maven-publish: automatically configures pom metadata
  • biz.aQute.bnd.builder: automatically configures meta-inf metadata
  • java-gradle-plugin: automatically configures Gradle plugin metadata