Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nebula-plugins/gradle-extra-configurations-plugin
Gradle plugin introducing a provided dependency configuration and marking a dependency as optional.
https://github.com/nebula-plugins/gradle-extra-configurations-plugin
Last synced: 6 days ago
JSON representation
Gradle plugin introducing a provided dependency configuration and marking a dependency as optional.
- Host: GitHub
- URL: https://github.com/nebula-plugins/gradle-extra-configurations-plugin
- Owner: nebula-plugins
- License: apache-2.0
- Created: 2014-01-27T17:54:43.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-12-21T00:42:46.000Z (15 days ago)
- Last Synced: 2024-12-22T23:03:03.990Z (13 days ago)
- Language: Groovy
- Homepage:
- Size: 1.12 MB
- Stars: 139
- Watchers: 24
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Nebula Extra Configurations
===========================
[](https://plugins.gradle.org/plugin/com.netflix.nebula.extra-configurations)
[](https://maven-badges.herokuapp.com/maven-central/com.netflix.nebula/gradle-extra-configurations-plugin)
[](http://www.apache.org/licenses/LICENSE-2.0)
This plugin allows dependencies to be declared with a configuration or attribute not available in Gradle core.
* `optional`
The following publishing plugins support the correct handling when generating the relevant metadata:
* [Maven Publishing](http://www.gradle.org/docs/current/userguide/publishing_maven.html)
* [Ivy Publishing](http://www.gradle.org/docs/current/userguide/publishing_ivy.html)
## Usage
### Adding the plugin binary to the build
To include, add the following to your build.gradle
plugins {
id 'com.netflix.nebula.optional-base' version '3.0.3' // if you want optional-base
id 'com.netflix.nebula.provided-base' version '3.0.3' // if you want provided-base
}
or
buildscript {
repositories { mavenCentral() }
dependencies {
classpath 'com.netflix.nebula:gradle-extra-configurations-plugin:3.0.3'
}
}
The JAR file comes with two plugins:
Plugin Identifier
Depends On
Type
Description
provided-base
-
ProvidedBasePlugin
Creates a new configuration named provided similar to providedCompile created by the
War plugin.
optional-base
-
OptionalBasePlugin
Provides an extra method for marking dependencies as optional.
To use the Provided plugin, include the following code snippet in your build script:
apply plugin: 'com.netflix.nebula.provided-base'
To use the Optional plugin, include the following code snippet in your build script:
apply plugin: 'com.netflix.nebula.optional-base'
### Using the provided plugin
A dependency declared with the `provided` configuration is available on the compilation and test classpath. However, when
publishing the outgoing artifact of the project (usually a JAR file) with Ivy or Maven, the dependency is not marked as
required transitive dependency.
This is what the [Maven documentation](http://maven.apache.org/pom.html#Dependencies) says:
> **provided** - this is much like compile, but indicates you expect the JDK or a container to provide it at runtime.
> It is only available on the compilation and test classpath, and is not transitive.
#### Impact on metadata created when publishing artifact
When publishing a provided dependency to a Maven repository the declaration in the POM looks as such:
...
org.apache.commons
commons-lang3
3.3.2
provided
...
When publishing a provided dependency to an Ivy repository the declaration in the Ivy file looks as such:
...
...
#### Usage example
apply plugin: 'java'
apply plugin: 'com.netflix.nebula.provided-base'
repositories {
mavenCentral()
}
dependencies {
provided 'org.apache.commons:commons-lang3:3.3.2'
provided group: 'log4j', name: 'log4j', version: '1.2.17'
}
### Using the optional plugin
A dependency marked with the `optional` attribute is a dependency that is not necessarily meant to be required. The idea
is that some of the dependencies are only used for certain features in the project, and will not be needed if that feature
isn't used. For more information, please have a look at the [Maven documentation](http://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html).
#### Impact on metadata created when publishing artifact
When publishing a optional dependency to a Maven repository the declaration in the POM looks as such:
...
org.apache.commons
commons-lang3
3.3.2
compile
true
...
When publishing a optional dependency to an Ivy repository the declaration in the Ivy file looks as such:
...
...
#### Usage example
apply plugin: 'java'
apply plugin: 'com.netflix.nebula.optional-base'
repositories {
mavenCentral()
}
dependencies {
compile 'org.apache.commons:commons-lang3:3.3.2', optional
compile group: 'log4j', name: 'log4j', version: '1.2.17', optional
}