Skip to content

Gradle plugin for checking differences between previous and current configuration dependencies.

License

Notifications You must be signed in to change notification settings

etraveli/bom-verifier

Repository files navigation

Build Status

BOM Verifier Plugin

Plugin for checking differences between previous and current configuration dependencies.

The plugin checks for differences between a local BOM file (defaults to [project.name].bom) and compares it to the specified configuration (defaults to 'runtime'). When there is differences the check will fail and inform you of them. Main usage is to make developers aware of changes they make to the classpath and make tracking classpath changes easier.

Applying the Plugin

// TODO

Usage

Configuration

bomVerifier {
  bomFilePath = 'custom/path/for-reading-and-wrinte/bom'
  bomFileName = 'custom-file-name-without.file-extension'
  configuration = project.configurations.someConfiguration
  includeProjectDependencyVersions = false
}
bomFilePath
You can customize the path where the plugin writes and looks for the BOM file.
Defaults to projects root dir.
bomFileName
You can customize the file name of the BOM file.
Defaults to projects name.
configuration
You can customize the configuration to use for the BOM.
Defaults to project.configurations.runtime.
includeProjectDependencyVersions
Set to 'true' if you want to include project dependency versions in the BOM.
Defaults to false, i.e. * (wildcard).

Tasks

verifyBom

writeNewBom

verifyBom
Used to verify that your runtime configurations dependencies match your dependencies declared in the BOM file.
This task gets added to the Java plugins 'check' task.
writeNewBom
Writes a new BOM file from your runtime configuration.

TODOs

  • Add tasks to Verification group
  • Add tasks descriptions
  • Add inputs and outputs for incremental builds
  • Add possibility to exclude dependencies

About

Gradle plugin for checking differences between previous and current configuration dependencies.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages