Open source

Add repository

Recipe IDorg.openrewrite.maven.AddRepository

Artifactorg.openrewrite:rewrite-maven

Adds a new Maven Repository or updates a matching repository.

Single recipeOpenRewriteApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

11 parameters

2 required9 optional

Parameter	Example	Type	Required
id	repo-id	String	Required
A unique name to describe the repository.
url	http://myrepo.maven.com/repo	String	Required
The URL of the repository.
layout	default	String	Optional
The Maven layout of the repository.
releasesChecksumPolicy	fail	String	Optional
Governs whether releases require checksums.
releasesEnabled	—	Boolean	Optional
Releases from the repository are available
releasesUpdatePolicy	never	String	Optional
The policy governing release updating interval.
repoName	My Great Repo Name	String	Optional
A display name for the repository.
snapshotsChecksumPolicy	warn	String	Optional
Governs whether snapshots require checksums.
snapshotsEnabled	—	Boolean	Optional
Snapshots from the repository are available.
snapshotsUpdatePolicy	always	String	Optional
The policy governing snapshot updating interval.
type	Repository	Type	Optional
The type of repository to add.

Examples

xml

Parameter	Value
id	myRepo
url	http://myrepo.maven.com/repo
repoName	null
layout	null
snapshotsEnabled	null
snapshotsChecksumPolicy	null
snapshotsUpdatePolicy	null
releasesEnabled	null
releasesChecksumPolicy	null
releasesUpdatePolicy	null
type	null

xml

Before

<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>

After

<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
  <repositories>
    <repository>
      <id>myRepo</id>
      <url>http://myrepo.maven.com/repo</url>
    </repository>
  </repositories>
</project>

Diff

--- pom.xml
+++ pom.xml
@@ -5,0 +5,6 @@
  <artifactId>my-app</artifactId>
  <version>1</version>
+ <repositories>
+   <repository>
+     <id>myRepo</id>
+     <url>http://myrepo.maven.com/repo</url>
+   </repository>
+ </repositories>
</project>

Usage

Run this recipe

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

shell

mod run . --recipe AddRepository --recipe-option "id=repo-id" --recipe-option "url=http://myrepo.maven.com/repo" --recipe-option "repoName=My Great Repo Name" --recipe-option "layout=default" --recipe-option "snapshotsChecksumPolicy=warn" --recipe-option "snapshotsUpdatePolicy=always" --recipe-option "releasesChecksumPolicy=fail" --recipe-option "releasesUpdatePolicy=never" --recipe-option "type=Repository"

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

mod config recipes jar install org.openrewrite:rewrite-maven:8.85.6

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

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

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

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

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

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

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

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