licensee/app.cash.licensee/LicenseeExtension

LicenseeExtension

interface LicenseeExtension

Types

AllowDependencyOptions

interface AllowDependencyOptions

AllowUrlOptions

interface AllowUrlOptions

IgnoreDependencyOptions

interface IgnoreDependencyOptions

Properties

androidAssetReportPath

abstract val androidAssetReportPath: Property<String>

The path within the Android assets/ directory to which the licensee report will be copied.

bundleAndroidAsset

abstract val bundleAndroidAsset: Property<Boolean>

Enable asset generation. Will copy licensee report to android asset directory making it available in androidAssetReportPath under assets/ in the APK.

Functions

allow

abstract fun allow(spdxId: SpdxId)

abstract fun allow(spdxId: String)

Allow artifacts with a license that matches a SPDX identifier.

allowDependency

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.

allowUrl

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

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

ignoreDependencies

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.

unusedAction

abstract fun unusedAction(level: UnusedAction)

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

violationAction

abstract fun violationAction(level: ViolationAction)

Build behavior when a license violation is found.