Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tomasbjerre/gradle-scripts

Releasing to Maven Central, Changelog generation, version management with conventional commits... a highly configurable shared Gradle script.
https://github.com/tomasbjerre/gradle-scripts

gradle gradle-script

Last synced: 4 months ago
JSON representation

Releasing to Maven Central, Changelog generation, version management with conventional commits... a highly configurable shared Gradle script.

Host: GitHub
URL: https://github.com/tomasbjerre/gradle-scripts
Owner: tomasbjerre
License: apache-2.0
Created: 2017-12-02T11:39:44.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2024-09-08T05:54:04.000Z (5 months ago)
Last Synced: 2024-09-29T03:41:20.323Z (4 months ago)
Topics: gradle, gradle-script
Language: JavaScript
Homepage:
Size: 470 KB
Stars: 13
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

This functionality moved to:

-
-
-

# Gradle Scripts

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/se.bjurr.gradle/gradle-scripts/badge.svg)](https://search.maven.org/artifact/se.bjurr.gradle/gradle-scripts)

This is a gradle script, written in a highly configurable way, much like I've [blogged about in Jenkins](https://www.jenkins.io/blog/2020/10/21/a-sustainable-pattern-with-shared-library/). It contains a bunch of features that I use in my Gradle projects.

Example usage can be found in:

- [Git Changelog Lib](https://github.com/tomasbjerre/git-changelog-lib/blob/master/build.gradle)
- [Git Changelog Command Line](https://github.com/tomasbjerre/git-changelog-command-line/blob/master/build.gradle)
- [Violations Lib](https://github.com/tomasbjerre/violations-lib/blob/master/build.gradle)
- [Violations Gradle Plugin](https://github.com/tomasbjerre/violations-gradle-plugin/blob/master/build.gradle)

## How does it work?

It packages a `jar`. Uploads it to a Maven repository. Users can add the `jar` to their classpath and apply the `main.gradle` script from that `jar`.

The behaviour of the script is highly configurable by supplying a `project.ext.buildConfig`. The given config will be merged with the [defaultConfig](src/main/resources/main.gradle).

```groovy
apply plugin: 'java-library'

buildscript {
repositories {
mavenCentral()
mavenLocal()
}
dependencies {
classpath 'se.bjurr.gradle:gradle-scripts:2.+'
}
}
project.ext.buildConfig = [
// Your can supply a given config here, a subset of defaultConfig.
]
apply from: project.buildscript.classLoader.getResource('main.gradle').toURI()
```

## Features

Missing something? Pull requests are welcome =)

All configuration options are documented in the [defaultConfig](src/main/resources/main.gradle).

```groovy

def defaultConfig = [
/**
* "DEFAULT" - Works for most Java projects.
* "GRADLE" - A Gradle plugin.
* "COMMAND" - Runnable JAR, distributed in Central and NPM.
*/
repoType: "DEFAULT",
sourceCompatibility: 17,
targetCompatibility: 17,
staticCodeAnalysis: [
/**
* Maximum number of violations to accept from static code analysis.
*/
maxViolations: 9999,
],
publishing: [
website: 'https://github.com/tomasbjerre/' + project.name,
vcsUrl: 'https://github.com/tomasbjerre/'+project.name,
licenseName: 'The Apache Software License, Version 2.0',
licenseUrl: 'http://www.apache.org/licenses/LICENSE-2.0.txt',
developerId: 'tomasbjerre',
developerName: 'Tomas Bjerre',
developerEmail: '[email protected]',
/**
* If using PasswordCredentials and repository name "nexus", you will
* need to supply username/password properties named "nexusUsername"
* and "nexusPassword". Perhaps in ~/.gradle/gradle.properties
*/
mavenRepositoryName: "nexus",
mavenRepositoryUrl: 'https://oss.sonatype.org/service/local/staging/deploy/maven2/',
/**
* true, if you want the repository in Nexus to be closed and pomoted to Release.
*/
nexusCloseAndRelease: true,
/**
* If using signing you will need to supply signing properties.
* Perhaps in ~/.gradle/gradle.properties
* https://docs.gradle.org/current/userguide/signing_plugin.html
*/
sign: true,
/**
* If not empty: creates a fat jar with relocated packages.
* Example: [ "com.google", "a.b:se.bjurr.a.b" ]
* Will make up a relocation target for "com.google" and will use "se.bjurr.a.b" as target for "a.b".
*/
relocate: [],
],
gradlePlugin: [
tags: []
],
changelog: [
enabled: true,
githubTokenEnvVariableName: 'GITHUB_OAUTH2TOKEN',
githubOrganization: 'tomasbjerre',
jiraIssuePattern: "\\bJENKINS-([0-9]+)\\b",
ignoreCommitsIfMessageMatches: "^\\[maven-release-plugin\\].*|^\\[Gradle Release Plugin\\].*|^Merge.*|.*\\[GRADLE SCRIPT\\].*"
],
violations: [
/**
* Update README.md with table of parsers and reporters.
*/
updateReadme: false
],
manifest: [
mainClass: ''
],
/**
* Will be configured if they exist.
*/
generatedSourceFolders: [
"src/gen/java",
"src/generated/java"
],
formattingExcludedPatterns: [
"**/gen/**",
"**/generated/**"
],
/**
* Will be configured if they exist.
*/
extraTestSourceFolders: [
"src/test/generated"
],
/**
* Used as "from" in jar if it exists. Can be used to do annotation processing.
*/
jarResourcesFolder: 'src/jar/resources'
]

```

### Publishing releases

It can:

- Step version
- Package release
- Sign release
- Publish release to repository (like Nexus or Maven Central)
- Create a changelog
- Commit/tag/push to Git
- Close and promote release in Nexus

With:

```sh
./gradlew releasePatch
./gradlew releaseMinor
./gradlew releaseMajor
```

Or by relying on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and just doing:

```sh
./gradlew release
```

### Static code analysis

It has `Spotbugs` configured in combination with [Violations Gradle Plugin](https://github.com/tomasbjerre/violations-gradle-plugin). Any violations will be printed nicely in the build log. And build can optionally be failed based on number of violations.

### Other features

- Automated changelog
- Code formatting, with Google Java Format.
- Shadowing, producing fat-jar
- Signing artifacts with PGP
- ...

## Requirements

Gradle wrapper can be downloaded with:

```sh
cat > gradle/wrapper/gradle-wrapper.properties << EOL
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
networkTimeout=10000
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
EOL

./gradlew wrapper \
--gradle-version=8.6 \
--distribution-type=bin
```

In many cases you can just run the `gradlew wrapper` task. But there are cases where this does not work. On such case is if you are using Java version X and the current wrapper only support version Y, the current wrapper cannot run. Se example error below:

```sh
$ java -version

openjdk version "21.0.2" 2024-01-16
OpenJDK Runtime Environment (build 21.0.2+13-Ubuntu-122.04.1)
OpenJDK 64-Bit Server VM (build 21.0.2+13-Ubuntu-122.04.1, mixed mode, sharing)
```

```sh
$ ./gradlew wrapper --gradle-version=8.6 --distribution-type=bin

Downloading https://X/distributions/gradle-6.8.3-bin.zip

...

FAILURE: Build failed with an exception.

* Where:
Build file 'X/build.gradle'

* What went wrong:
Could not compile build file 'X/build.gradle'.
> startup failed:
General error during semantic analysis: Unsupported class file major version 65

java.lang.IllegalArgumentException: Unsupported class file major version 65
at groovyjarjarasm.asm.ClassReader.(ClassReader.java:196)
```

## Developer instructions

You can fiddle with the script localy by installning it with:

```sh
./gradlew publishToMavenLocal -Pversion=latest-SNAPSHOT
```