Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Grails plugin that enables JBoss TattleTale report generation
Groovy
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
grails-app/conf
scripts
.gitignore
LICENSE
README.md
TattletaleGrailsPlugin.groovy
application.properties

README.md

Grails TattleTale Plugin

This plugin will execute JBoss Tattletale reports on a Grails application. Tattletale reports are useful for inspecting the dependencies included in a packaged application for things like unused JAR files, duplicate classes on the classpath and other inconsitencies that may cause issues at runtime.

To use this plugin in your application, add the following dependency to the plugins closure in your application's grails-app/conf/BuildConfig.groovy file:

build 'org.grails.plugins:tattletale:1.0.0'

Usage

By default, the TattleTale reports will be automatically be generated after packaging of the WAR file has completed, if it has been enabled. There are two ways to enable the TattleTale report generation. The first is to include the -tattle command line argument when packaging the application:

grails war -tattle

The second approach is to add the enabledByDefault configuration property to your application's grails-app/conf/BuildConfig.groovy file:

tattletale {
    enabledByDefault = true
}

The plugin also supports the explicit disabling of the TattleTale reports:

grails war -notattling

This approach will override the enableByDefault configuration property.

Configuration Options

Property Description Default Value
classloader Specifies which classloader structure that should be used when scanning the archives.
enabledByDefault Enables the generation of TattleTale reports by default when packaging a Grails application false
excludes Comma separated list of JAR files to be excluded from the reports
profiles Comma separated list of profiles to enabled when generating TattleTale reports spring30,java6
reports Comma separated list of TattleTale reports to be executed on the Grails application multiplejars,unusedjar
reportsDir The output location for the generated reports target/tattletale-report

See the TattleTale configuration documentation for more details.

Building the plugin

To build the plugin locally, follow these steps:

  1. Clone the grails-tattletale repository from GitHub:

    > git clone https://github.com/jdpgrailsdev/grails-tattletale.git
    
  2. Change directory to the checked out project:

    > cd grails-tattletale
    
  3. Package and install the binary in your local Maven repository:

    > grails maven-install
    

Release History:

  • 1.0.0
    • Initial release of the Grails JBoss TattleTale plugin.
Something went wrong with that request. Please try again.