https://github.com/nebula-plugins/gradle-resolution-rules

Rules for the Resolution Rules plugin
https://github.com/nebula-plugins/gradle-resolution-rules

Last synced: about 2 months ago
JSON representation

Rules for the Resolution Rules plugin

• Host: GitHub
• URL: https://github.com/nebula-plugins/gradle-resolution-rules
• Owner: nebula-plugins
• License: apache-2.0
• Created: 2016-04-27T20:03:26.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-18T00:26:18.000Z (3 months ago)
• Last Synced: 2024-10-20T11:44:13.119Z (3 months ago)
• Language: Groovy
• Size: 1.06 MB
• Stars: 13
• Watchers: 20
• Forks: 19
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Gradle Resolution Rules

=======

![Support Status](https://img.shields.io/badge/nebula-active-green.svg)

[![Maven Central](https://img.shields.io/maven-central/v/com.netflix.nebula/gradle-resolution-rules)](https://maven-badges.herokuapp.com/maven-central/com.netflix.nebula/gradle-resolution-rules)

![Build](https://github.com/nebula-plugins/gradle-resolution-rules/actions/workflows/nebula.yml/badge.svg)

[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-resolution-rules.svg)](http://www.apache.org/licenses/LICENSE-2.0)

Rules for the [Gradle Resolution Rules plugin](https://github.com/nebula-plugins/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](https://github.com/nebula-plugins/gradle-resolution-rules-plugin#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

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.