licensee/app.cash.licensee/LicenseeExtension

LicenseeExtension

interface LicenseeExtension

Types

Link copied to clipboard
Link copied to clipboard
interface AllowUrlOptions
Link copied to clipboard

Functions

Link copied to clipboard
abstract fun allow(spdxId: String)

Allow artifacts with a license that matches a SPDX identifier.

Link copied to clipboard
abstract fun allowDependency(dependencyProvider: Provider<out Dependency>, options: Action<LicenseeExtension.AllowDependencyOptions> = Action { })

abstract fun allowDependency(groupId: String, artifactId: String, version: String, options: Action<LicenseeExtension.AllowDependencyOptions> = Action { })

Allow an artifact with a specific groupId, artifactId, and version. This is useful for artifacts which contain no license data or have invalid/incorrect license data.

Link copied to clipboard
abstract fun allowUrl(url: String, options: Action<LicenseeExtension.AllowUrlOptions> = Action { })

Allow artifacts with an unknown (non-SPDX) license which matches a URL.

Link copied to clipboard
abstract fun ignoreDependencies(groupId: String, artifactId: String? = null, options: Action<LicenseeExtension.IgnoreDependencyOptions> = Action { })

Ignore a single dependency or group of dependencies during dependency graph resolution. Artifacts targeted with this method will not be analyzed for license information and will not show up in any report files.

Link copied to clipboard
abstract fun unusedAction(level: UnusedAction)

Build behavior when a declared license is not found in any dependencies of the project.

Link copied to clipboard
abstract fun violationAction(level: ViolationAction)

Build behavior when a license violation is found.