Bom-Plugin

A gradle plugin that helps you create a maven bom and all constants related to its dependencies.

Features

• Generate Bill of materials pom.xml
• Generate Kotlin classes to represent all dependencies from the bill of materials

Setup

Using kotlin

plugin-DSL:

plugins {
    id("dev.thiagosouto.plugins.bom-plugin") version "0.7.0"
}

legacy plugin application:

buildscript {
    repositories {
        maven {
            url = uri("https://plugins.gradle.org/m2/")
        }
    }
    dependencies {
        classpath("dev.thiagosouto:bom-plugin:0.7.0")
    }
}

apply(plugin = "dev.thiagosouto.plugins.bom-plugin")

Using groovy

plugin-DSL:

plugins {
    id "dev.thiagosouto.plugins.bom-plugin" version "0.7.0"
}

legacy plugin application:

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "dev.thiagosouto:bom-plugin:0.7.0"
    }
}

apply plugin: "dev.thiagosouto.plugins.bom-plugin"

BomMetadata

bomMetadata{
    artifactId = "some-artifact-id" // The id of the artifact(pom.xml) created
    description = "some description" // artifact description
    groupId = "some.group.id" //  The id for the project group.
    name = "some-name" // Name of your bom project
    version = "someVersion"// The version of the artifact created
    licenseName = "" // license of your bom, could be empty if not exist
    licenseUrl = "" // license url of your bom, could be empty if not exist
    developerId = "" // developer id of your BOM, could be empty if not exist
    developerName = "" // developer name of your BOM, could be empty if not exist
    developerEmail = "" // developer email of your BOM, could be empty if not exist
    scmConnection = "" // scm connection your BOM, could be empty if not exist
    scmDeveloperConnection = ""// scm developer connection your BOM, could be empty if not exist
    scmUrl = ""// scm url your BOM, could be empty if not exist
    url = ""// pom.xml url
    gpgSign = false // true to add sign step to pom.xml using gpg
    bomClassName = "" // name of the class name that wil include all dependencies
}

Dependencies

You need to use implementation and bomConfiguration to declare the dependencies that will be added to the pom.xml and kotlin generated classes.

Tasks

./gradlew createBomFile will create the pom.xml in build/outputs/bom/pom.xml ./gradlew createBomClass will create the kotlin classes that represents the pom.xml. They will be placed in build/outputs/bom/some/group/id

Developer contact

Linkedin

Medium

License

MIT License

    Copyright (c) 2021 Thiago Souto

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.