Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 3.1 KB

README.md

File metadata and controls

65 lines (43 loc) · 3.1 KB
Raw

Gradle Resolution Rules

Support Status Maven Central Build Apache 2.0

Rules for the Gradle Resolution Rules plugin.

This project includes rules for libraries available in Maven Central.

Using the rules

Add a dependency on this project to apply the rules to the project:

dependencies {
    resolutionRules 'com.netflix.nebula:gradle-resolution-rules:latest.release'
}

The artifact is available on Maven Central.

Included rules

Refer to the JSON files in src/main/resources for details of the included rules. Optional rules are documented below.

Optional rules

Optional rules can be enabled by adding the name of the rule set to the list of optional rules:

nebulaResolutionRules {
    optional = ['slf4j-bridge']
}
Rule Set Name Description
slf4j-bridge Replaces concrete logging implementations with SLF4J bridges
spring-boot-log4j2 Excludes concrete logging implementations that conflict with the Spring Boot Log4J starter

Contributing Rules

Contributions are more than welcome, however please keep these guidelines in mind when submitting a pull request:

  • Default rules are intended to offer correctness. For example, a rule that tells Gradle that Google Collections was replaced by Guava provides correctness, as it causes those libraries with overlapping classes to conflict resolve
  • Optional rules are intended for rules that might cause problems due to edge cases, or provide a useful opinion. For instance, replacing Log4J with the SLF4J bridge is an opinion, but useful and correct when using SLF4J
  • Opinions that prefer one library over another, when it's not a compatible replacement (see 'correctness' above) are not suitable rules for this project
  • Rules should be for libraries in commonly used, public repositories, that have broad use. For esoteric use cases, we recommend publishing your own rules using the Producing rules instructions.

LICENSE

Copyright 2016 Netflix, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.