Skip to main content

Show Git source control metadata

org.openrewrite.FindGitProvenance

List out the contents of each unique GitProvenance marker in the set of source files. When everything is working correctly, exactly one such marker should be printed as all source files are expected to come from the same repository / branch / commit hash.

Recipe source

GitHub, Issue Tracker, Maven Central

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.

  1. Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("7.6.1")
}

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

repositories {
mavenCentral()
}

  1. 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

Distinct Git Provenance

org.openrewrite.table.DistinctGitProvenance

List out the contents of each unique GitProvenance marker in the set of source files. When everything is working correctly, exactly one such marker should be printed as all source files are expected to come from the same repository / branch / commit hash.

Column NameDescription
OriginThe URL of the git remote.
BranchThe branch that was checked out at the time the source file was parsed.
ChangesetThe commit hash of the changeset that was checked out.
AutoCRLFThe value of the core.autocrlf git config setting.
EOLThe value of the core.eol git config setting.

Contributors

Kevin McCarpenter™️, Jonathan Schnéider, Tim te Beek