Analyse Organization's Release Train Metro Plan

io.moderne.recipe.releasemetro.ReleaseMetroPlan

Gathers the basic information to create and understand the organizations release train metro plan.

Recipe source

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Usage

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ReleaseMetroPlan

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-release-metromap:0.1.0

See how this recipe works across multiple open-source repositories

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

Run this recipe here

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

ProjectCoordinates

Maven or Gradle Artifact coordinates IDs

io.moderne.recipe.releasemetro.table.ProjectCoordinates

Maven Modules or Gradle (sub-)project groupId and artifactId.

Column Name	Description
groupId	Group ID of the current module/subproject
artifactId	Artifact ID of the current module/subproject

SourcesFileResults

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

SearchResults

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column Name	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

SourcesFileErrors

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

RecipeRunStats

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.

ParentRelationships

Maven Parent and Gradle Project Hierarchies

io.moderne.recipe.releasemetro.table.ParentRelationships

Relationships between child projects and their parent POMs or Gradle parent projects.

Column Name	Description
childGroupId	Group ID of the child project
childArtifactId	Artifact ID of the child project
parentGroupId	Group ID of the parent project
parentArtifactId	Artifact ID of the parent project
parentVersion	Version of the parent project
hierarchyType	Type of hierarchy relationship (MAVEN_PARENT or GRADLE_PARENT)

UnusedDependencies

Potentially Unused Dependencies

io.moderne.recipe.releasemetro.table.UnusedDependencies

Dependencies that are declared in build files but may not be used based on import analysis.

Column Name	Description
dependencyGroupId	Group ID of the potentially unused dependency
dependencyArtifactId	Artifact ID of the potentially unused dependency
dependencyVersion	Version of the potentially unused dependency
dependencyScope	Scope of the dependency (compile, test, etc.)
isDirect	Whether this is a direct dependency (not transitive)
reasonSuspected	Reason why this dependency is suspected to be unused

DependenciesInUse

Dependencies in use

org.openrewrite.maven.table.DependenciesInUse

Direct and transitive dependencies in use.

Column Name	Description
Project name	The name of the project that contains the dependency.
Source set	The source set that contains the dependency.
Group	The first part of a dependency coordinate com.google.guava:guava:VERSION.
Artifact	The second part of a dependency coordinate com.google.guava:guava:VERSION.
Version	The resolved version.
Dated snapshot version	The resolved dated snapshot version or null if this dependency is not a snapshot.
Scope	Dependency scope. This will be compile if the dependency is direct and a scope is not explicitly specified in the POM.
Count	How many times does this dependency appear.