Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 3.31 KB

findbuildtoolfailures.md

File metadata and controls

105 lines (81 loc) · 3.31 KB

Find source files with BuildToolFailure markers

org.openrewrite.FindBuildToolFailures

This recipe explores build tool failures after an LST is produced for classifying the types of failures that can occur and prioritizing fixes according to the most common problems.

Source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite
  • artifactId: rewrite-core
  • version: 8.1.3

Options

Type Name Description
Boolean suppressLogOutput Optional. Default false. If true, the logOutput column will be empty in the output table.

Data Tables (Only available on the Moderne platform)

Build tool failures

Log output of failed build tool runs along with exit code and further diagnostics.

Column Name Description
Type The type of build tool that failed.
Version The version of the build tool that failed, if available.
Command The command that was executed.
Exit code The exit code of the build tool run.
Required Java version The required Java version for the build, if detectable.
Log output The log output of the build tool run.

Usage

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies. {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("org.openrewrite.FindBuildToolFailures")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.FindBuildToolFailures</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} You will need to have Maven installed on your machine before you can run the following command. {% code title="shell" %}

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.activeRecipes=org.openrewrite.FindBuildToolFailures

{% endcode %} {% endtab %} {% endtabs %}

Contributors

See how this recipe works across multiple open-source repositories

Moderne Link Image

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.