gradle-build-greeting

A Gradle plugin that shows build environment information at the start of a Gradle run.

Example Greeting

BUILDING someproject - Gradle: 9.1.0, Kotlin: 2.2.0, Java: 21.0.4, OS: Linux, Host: foobar

Usage

The plugin is available from the Gradle Plugin Portal and can be applied to a Gradle project using the plugins block.

To display the greeting, apply the plugin:

plugins {
    java
    id("org.cthing.build-greeting") version "1.0.0"
}

Compatibility

The following Gradle and Java versions are supported:

Plugin Version	Gradle Version	Minimum Java Version
1.0.0+	8.0+, 9.0+	17

Building

The plugin is compiled for Java 17. If a Java 17 toolchain is not available, one will be downloaded.

Gradle is used to build the plugin:

./gradlew build

The Javadoc for the plugin can be generated by running:

./gradlew javadoc

Releasing

This project is released on the Gradle Plugin Portal. Perform the following steps to create a release.

• Commit all changes for the release
• In the build.gradle.kts file, edit the ProjectVersion object
  • Set the version for the release. The project follows semantic versioning.
  • Set the build type to BuildType.release
• Commit the changes
• Wait until CI successfully builds the release candidate
• Verify GitHub Actions build is successful
• In a browser go to the C Thing Software Jenkins CI page
• Run the "gradle-build-greeting-validate" job
• Wait until that job successfully completes
• Run the "gradle-build-greeting-release" job to release the plugin to the Gradle Plugin Portal
• Wait for the plugin to be reviewed and made available by the Gradle team
• In a browser, go to the project on GitHub
• Generate a release with the tag <version>
• In the build.gradle.kts file, edit the ProjectVersion object
  • Increment the version patch number
  • Set the build type to BuildType.snapshot
• Update the CHANGELOG.md with the changes in the release and prepare for next release changes
• Update the Usage and Compatibility sections in the README.md with the latest artifact release version
• Commit these changes