diff --git a/docs/gradle.rst b/docs/gradle.rst new file mode 100644 index 00000000000..e6110f05878 --- /dev/null +++ b/docs/gradle.rst @@ -0,0 +1,32 @@ +Using the SpotBugs Gradle Plugin +================================ + +This chapter describes how to integrate SpotBugs into a build script for Gradle. + +Use SpotBugs Gradle Plugin +-------------------------- + +Please follow instruction found on `official Gradple Plugin page `_. + +Tasks introduced by this Gradle Plugin +-------------------------------------- + +This Gradle Plugin introduces two tasks: `spotbugsMain and `spotbugsTest. + +`spotbugsMain` task runs SpotBugs for your production Java source files. This task depends on `classes` task. +`spotbugsTest` task runs SpotBugs for your test Java source files. This task depends on `testClasses` task. + +SpotBugs Gradle Plugin adds task dependency from `check` to these these tasks, so you can simly run ``./gradlew check`` to run SpotBugs. + +Configure Gradle Plugin +----------------------- + +Current version of SpotBugs Gradle Plugin uses the same way to configure. Please check the document for `FindBugsExtension `_. + +For instance, to specify the version of SpotBugs, you can configure like below: + +.. code-block:: groovy + + spotbugs { + toolVersion = '3.1.0-RC5' + } diff --git a/docs/index.rst b/docs/index.rst index a418e99095d..bad2b509f66 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,6 +28,7 @@ Contents gui eclipse ant + gradle filter analysisprops implement-plugin diff --git a/docs/locale/ja/LC_MESSAGES/gradle.po b/docs/locale/ja/LC_MESSAGES/gradle.po new file mode 100644 index 00000000000..7557983bcff --- /dev/null +++ b/docs/locale/ja/LC_MESSAGES/gradle.po @@ -0,0 +1,76 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2016-2017, spotbugs community +# This file is distributed under the same license as the spotbugs package. +# FIRST AUTHOR , 2017. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: spotbugs 3.1\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2017-08-25 02:42+0000\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 1.3\n" + +#: ../../gradle.rst:2 +msgid "Using the SpotBugs Gradle Plugin" +msgstr "" + +#: ../../gradle.rst:4 +msgid "" +"This chapter describes how to integrate SpotBugs into a build script for " +"Gradle." +msgstr "" + +#: ../../gradle.rst:7 +msgid "Use SpotBugs Gradle Plugin" +msgstr "" + +#: ../../gradle.rst:9 +msgid "" +"Please follow instruction found on `official Gradple Plugin page " +"`_." +msgstr "" + +#: ../../gradle.rst:12 +msgid "Tasks introduced by this Gradle Plugin" +msgstr "" + +#: ../../gradle.rst:14 +msgid "This Gradle Plugin introduces two tasks: `spotbugsMain and `spotbugsTest." +msgstr "" + +#: ../../gradle.rst:16 +msgid "" +"`spotbugsMain` task runs SpotBugs for your production Java source files. " +"This task depends on `classes` task. `spotbugsTest` task runs SpotBugs " +"for your test Java source files. This task depends on `testClasses` task." +msgstr "" + +#: ../../gradle.rst:19 +msgid "" +"SpotBugs Gradle Plugin adds task dependency from `check` to these these " +"tasks, so you can simly run ``./gradlew check`` to run SpotBugs." +msgstr "" + +#: ../../gradle.rst:22 +msgid "Configure Gradle Plugin" +msgstr "" + +#: ../../gradle.rst:24 +msgid "" +"Current version of SpotBugs Gradle Plugin uses the same way to configure." +" Please check the document for `FindBugsExtension " +"`_." +msgstr "" + +#: ../../gradle.rst:26 +msgid "" +"For instance, to specify the version of SpotBugs, you can configure like " +"below:" +msgstr ""