diff --git a/README.md b/README.md index 4a97c17f..cc7e3b64 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=2.5.0-rc-1&color=blue)](https://search.maven.org/artifact/de.skuzzle.enforcer/restrict-imports-enforcer-rule/2.5.0-rc-1/jar) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=2.5.0-rc-2&color=blue)](https://search.maven.org/artifact/de.skuzzle.enforcer/restrict-imports-enforcer-rule/2.5.0-rc-2/jar) [![Coverage Status](https://coveralls.io/repos/github/skuzzle/restrict-imports-enforcer-rule/badge.svg?branch=master)](https://coveralls.io/github/skuzzle/restrict-imports-enforcer-rule?branch=master) [![Twitter Follow](https://img.shields.io/twitter/follow/skuzzleOSS.svg?style=social)](https://twitter.com/skuzzleOSS) # restrict-imports-enforcer-rule Keep your code base clean and free from usage of unwanted classes! [More](#rationale) +**NEW** in 2.5.0: We now also provide a Gradle plugin! + Supported source files: - [x] Java - [x] Kotlin (since 0.15) - [x] Groovy (since 0.15) +Compatibility: +- Works with Java 8+ - Tested against _maven-enforcer-plugin_ versions `1.4.1` and `3.4.0`. -**NEW** in 2.5.0: We now also provide a Gradle plugin! - ## Maven quick start This is a minimal usage example. Please scroll down for detailed configuration information or have a look at the [Full configuration example](#full-configuration-example). @@ -29,7 +31,7 @@ information or have a look at the [Full configuration example](#full-configurati de.skuzzle.enforcer restrict-imports-enforcer-rule - 2.5.0-rc-1 + 2.5.0-rc-2 @@ -60,14 +62,14 @@ information or have a look at the [Full configuration example](#full-configurati > [!CAUTION] > Gradle support is quite new and should be considered experimental. -> Documentation will follow, for now you can check out the func tests [here](https://github.com/skuzzle/restrict-imports-enforcer-rule/blob/gradle-plugin/restrict-imports-gradle-plugin/src/functionalTest/groovy/de/skuzzle/restrictimports/gradle/RestrictImportsGroovyFuncTest.groovy). +> Documentation will follow, for now you can check out the func tests [here](https://github.com/skuzzle/restrict-imports-enforcer-rule/blob/master/restrict-imports-gradle-plugin/src/functionalTest/groovy/de/skuzzle/restrictimports/gradle/RestrictImportsGroovyFuncTest.groovy). > > Feedback is welcome and should be filed as new GitHub issue. ### ... with Groovy DSL ``` plugins { - id("de.skuzzle.restrict.imports") version("2.5.0-rc-1") + id("de.skuzzle.restrict.imports") version("@2.5.0-rc-2@") } restrictImports { @@ -79,7 +81,7 @@ restrictImports { ### ... with Kotlin DSL ``` plugins { - id("de.skuzzle.restrict.imports") version("2.5.0-rc-1") + id("de.skuzzle.restrict.imports") version("@2.5.0-rc-2@") } restrictImports { diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index cb8196b0..343962e2 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,7 +1,13 @@ -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=2.5.0-rc-1&color=blue)](https://search.maven.org/artifact/de.skuzzle.enforcer/restrict-imports-enforcer-rule/2.5.0-rc-1/jar) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=2.5.0-rc-2&color=blue)](https://search.maven.org/artifact/de.skuzzle.enforcer/restrict-imports-enforcer-rule/2.5.0-rc-2/jar) + +> [!NOTE] +> This is the first release after migrating our build to Gradle and which uses shaded dependencies. +> If you encounter any irregularities with this version, please do not hesitate to file an issue. ### Features +* [#38](https://github.com/skuzzle/restrict-imports-enforcer-rule/issues/38) Dependencies are shaded into plugin artifacts * [#59](https://github.com/skuzzle/restrict-imports-enforcer-rule/issues/59) Provide a Gradle plugin +* [#118](https://github.com/skuzzle/restrict-imports-enforcer-rule/issues/118) Print absolute paths in exception messages to make IntelliJ render clickable links Maven Central coordinates for this release: @@ -10,14 +16,14 @@ maven de.skuzzle.enforcer restrict-imports-enforcer-rule - 2.5.0-rc-1 + 2.5.0-rc-2 ``` Gradle plugin DSL ```groovy plugins { - id("de.skuzzle.restrict.imports") version "2.5.0-rc-1" + id("de.skuzzle.restrict.imports") version "2.5.0-rc-2" } ``` @@ -30,7 +36,7 @@ buildscript { } } dependencies { - classpath("de.skuzzle.enforcer:restrict-imports-gradle-plugin:2.5.0-rc-1") + classpath("de.skuzzle.enforcer:restrict-imports-gradle-plugin:2.5.0-rc-2") } } @@ -40,5 +46,5 @@ apply(plugin = "de.skuzzle.restrict.imports") Gradle version catalog (Toml) ```toml [plugins] -restrict-imports = { id = "de.skuzzle.restrict.imports", version = "2.5.0-rc-1" } +restrict-imports = { id = "de.skuzzle.restrict.imports", version = "2.5.0-rc-2" } ```