OpenGood Config Gradle Plugin

Gradle plugin providing centralized configuration of OpenGood Gradle projects

Usage

Add opengood-config Gradle plugin to build.gradle.kts:

plugins {
    id("io.opengood.gradle.config") version "VERSION"
}

Note: See Release version badge above for latest version.

Customize

The plugin supports customized properties:

Sections

Main

Property	Description	Default
projectType	Type of project. Supported (APP, LIB)	LIB

Features

Property	Description	Default
assertj	Value indicating if AssertJ dependency is enabled	false
jackson	Value indicating if Jackson dependency is enabled	true
jacksonKotlin	Value indicating if Jackson Kotlin dependency is enabled	true
junitJupiter	Value indicating if JUnit Jupiter dependency is enabled	false
kotest	Value indicating if Kotest dependencies are enabled	true
kotestSpring	Value indicating if Kotest Spring dependency is enabled	true
kotlinCoroutines	Value indicating if Kotlin Coroutines dependency is enabled	true
lombok	Value indicating if Lombok dependency is enabled	false
mockito	Value indicating if Mockito dependency is enabled	false
mockk	Value indicating if MockK dependency is enabled	true
spring	Value indicating if Spring dependencies are enabled	true
springMockk	Value indicating if Spring MockK dependency is enabled	true

Test

Property	Description	Default
maxParallelForks	Number of concurrent test classes to execute	Available Processors / 2 + 1

Artifact

Property	Description	Default
name	Name of artifact	Gradle project.name
packaging	Type of packaging. Supported (JAR)	JAR
description	Description of artifact
uri	URI of artifact project repository	GitHub Org URI + Gradle project.name
publications	Publication(s) of artifact. Supported (GITHUB, MAVEN_CENTRAL_PORTAL)	MAVEN_CENTRAL_PORTAL
autoRelease	Value indicating if artifact should be automatically released	true
repo	Artifact repository details	see Artifact Repository
scm	SCM details	see SCM
licenses	License details	see License
developer	Developer details	see Developer

Artifact Repository

Property	Description	Default
gitHubPackagesRepoUri	URI of GitHub packages artifact repository	https://maven.pkg.github.com/ + GitHub Org URI + Gradle project.name

Source Control Management (SCM)

Property	Description	Default
provider	SCM provider. Supported (GIT)	GIT
connection	Connection URI to SCM repository	scm:git: + GitHub Org URI + Gradle project.name
devConnection	Development connection URI to SCM repository	scm:git: + GitHub Org URI + Gradle project.name
uri	URI of SCM project repository	GitHub Org URI + Gradle project.name

License

Property	Description	Default
name	Name of license	MIT
uri	URI of license	GitHub Org URI + Gradle project.name + LICENSE

Developer

Property	Description	Default
id	Identifier of developer	opengood
name	Name of developer	OpenGood
email	Email address of developer	[email protected]

Example

import io.opengood.gradle.enumeration.PackagingType
import io.opengood.gradle.enumeration.ProjectType
import io.opengood.gradle.enumeration.PublicationType
import io.opengood.gradle.enumeration.ScmProvider

plugins {
    id("io.opengood.gradle.model") version "VERSION"
}

opengood {
    main {
        projectType = ProjectType.APP
    }
    features {
        assertj = false
        jackson = false
        jacksonKotlin = false
        junitJupiter = false
        kotest = false
        kotestSpring = false
        kotlinCoroutines = false
        lombok = false
        mockito = false
        mockk = false
        spring = false
        springMockk = false
    }
    test {
        maxParallelForks = 1
    }
    artifact {
        name = "test"
        packaging = PackagingType.JAR
        description = "description"
        uri = "https://repo.uri/project"
        publications = listOf(PublicationType.GITHUB)
        autoRelease = false
        repo {
            gitHubPackagesRepoUri = "https://github.packages.uri"
        }
        scm {
            provider = ScmProvider.GIT
            connection = "scm:git:https://repo.uri/project"
            devConnection = "scm:git:https://repo.uri/project"
            uri = "https://repo.uri/project"
        }
        license {
            name = "MIT"
            uri = "https://repo.uri/project/LICENSE"
        }
        developer {
            id = "developer"
            name = "Developer"
            email = "[email protected]"
        }
    }
}

---

Development

Gradle

To update Gradle wrapper to the latest version, run:

./gradlew wrapper --gradle-version VERSION

Versions

To update dependency and plugin versions, run:

./gradlew refreshVersions

Publish

Plugin

Note: Used for publishing OpenGood Gradle plugins to Gradle plugin repository

Local

• Using Gradle account with API key for publishing, add credentials to ~/.gradle/gradle.properties:

  gradle.publish.key=<gradle-api-key>
  gradle.publish.secret=<gradle-api-key-secret>

• Create release version and publish plugin to Gradle plugin repository:

  ./gradlew clean release -Prelease.useAutomaticVersion=true

  Note: publishPlugins task is configured with Gradle release plugin to execute after release build

CI/CD

• Using Gradle account with API key for publishing, add environment variables to CI job:

  GRADLE_PUBLISH_KEY=<gradle-api-key>
  GRADLE_PUBLISH_SECRET=<gradle-api-key-secret>
  

• Create release version and publish plugin to Gradle plugin repository by creating a Pull Request in GitHub tagged with release and merge to main branch

Artifact

Note: Used for publishing artifacts using opengood-config Gradle plugin to Maven Central Portal repository

Local

Maven Central Portal

• Using Maven Central Portal account with GPG key for publishing, add credentials to ~/.gradle/gradle.properties:

  mavenCentralUsername=<maven-central-portal-account-username>
  mavenCentralPassword=<maven-central-portal-account-password>
  
  signing.keyId=<gpg-key-id>
  signing.password=<gpg-key-password>
  signing.secretKeyRingFile=<gpg-keys-file-path>

• Create release version and publish artifact to Maven Central Portal repository:

  ./gradlew clean release -Prelease.useAutomaticVersion=true

  Note: publishAllPublicationsToMavenCentralRepository tasks are configured with Gradle release plugin to execute after release build

GitHub

• Using GitHub account for publishing, add credentials to ~/.gradle/gradle.properties:

  githubPackagesRepoPassword=<github-account-username>
  githubPackagesRepoUsername=<github-access-token>

• Create release version and publish artifact to GitHub packages repository:

  ./gradlew clean release -Prelease.useAutomaticVersion=true

  Note: publishGitHubPublicationToGitHubPackagesRepository tasks are configured with Gradle release plugin to execute after release build

CI/CD

Maven Central Portal

• Using Maven Central Portal account with GPG key for publishing, add environment variables to CI job:

  ORG_GRADLE_PROJECT_mavenCentralUsername=<maven-central-portal-account-username>
  ORG_GRADLE_PROJECT_mavenCentralPassword=<maven-central-portal-account-password>
  ORG_GRADLE_PROJECT_signingInMemoryKey=<gpg-key-private-key>
  ORG_GRADLE_PROJECT_signingInMemoryKeyPassword=<gpg-key-password>
  

  Note: gpg-key-private-key must be in ASCII armored format

• Create release version and publish plugin to Maven Central Portal repository by creating a Pull Request in GitHub tagged with release and merge to main branch

GitHub

• Using GitHub account for publishing, add environment variables to CI job:

  GITHUB_ACTOR=<github-account-username>
  GITHUB_TOKEN=<github-access-token>
  

  Note: By default, these environment variables are automatically by added GitHub

• Create release version and publish plugin to GitHub packages repository by creating a Pull Request in GitHub tagged with release and merge to main branch