Skip to main content

Find LST provenance

org.openrewrite.FindLstProvenance

Produces a data table showing what versions of OpenRewrite/Moderne tooling was used to produce a given LST.

Recipe source​

GitHub: FindLstProvenance.java, Issue Tracker, Code Genome Project

This recipe is available under the Apache License Version 2.0.

Usage​

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

  1. Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
    ~/.gradle/gradle.properties
    codeGenomeUsername=you@example.com
    codeGenomeToken=your-download-token
  2. Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:
    settings.gradle
    pluginManagement {
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = providers.gradleProperty("codeGenomeUsername").get()
                    password = providers.gradleProperty("codeGenomeToken").get()
                }
            }
            // Keep the portal for any other plugins your build applies
            gradlePluginPortal()
        }
    }
  3. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("org.openrewrite.FindLstProvenance")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = providers.gradleProperty("codeGenomeUsername").get()
                password = providers.gradleProperty("codeGenomeToken").get()
            }
        }
    }
  4. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

LST provenance​

org.openrewrite.table.LstProvenanceTable

Table showing which tools were used to produce LSTs.

Column NameDescription
Build tool typeThe type of tool which produced the LST.
Build tool versionThe version of the build tool which produced the LST.
LST serializer versionThe version of LST serializer which produced the LST.
Timestamp (epoch millis)UTC timestamp describing when the LST was produced, in milliseconds since the unix epoch.
TimestampUTC timestamp describing when the LST was produced, in ISO-8601 format. e.g.: "2023‐08‐07T22:24:06+00:00 UTC+00:00"