Skip to main content

Add repository

org.openrewrite.maven.AddRepository

Adds a new Maven Repository or updates a matching repository.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringidA unique name to describe the repository.repo-id
StringurlThe URL of the repository.http://myrepo.maven.com/repo
StringrepoNameOptional. A display name for the repository.My Great Repo Name
StringlayoutOptional. The Maven layout of the repository.default
BooleansnapshotsEnabledOptional. Snapshots from the repository are available.
StringsnapshotsChecksumPolicyOptional. Governs whether snapshots require checksums.warn
StringsnapshotsUpdatePolicyOptional. The policy governing snapshot updating interval.always
BooleanreleasesEnabledOptional. Releases from the repository are available
StringreleasesChecksumPolicyOptional. Governs whether releases require checksums.fail
StringreleasesUpdatePolicyOptional. The policy governing release updating interval.never
TypetypeOptional. The type of repository to add.Repository

Example​

Parameters​
ParameterValue
idmyRepo
urlhttp://myrepo.maven.com/repo
repoNamenull
layoutnull
snapshotsEnablednull
snapshotsChecksumPolicynull
snapshotsUpdatePolicynull
releasesEnablednull
releasesChecksumPolicynull
releasesUpdatePolicynull
typenull
Before​
pom.xml
<project>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>
After​
pom.xml
<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>

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.AddRepositoryExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddRepositoryExample
displayName: Add repository example
recipeList:
  - org.openrewrite.maven.AddRepository:
      id: repo-id
      url: http://myrepo.maven.com/repo
      repoName: My Great Repo Name
      layout: default
      snapshotsChecksumPolicy: warn
      snapshotsUpdatePolicy: always
      releasesChecksumPolicy: fail
      releasesUpdatePolicy: never
      type: Repository

Now that com.yourorg.AddRepositoryExample has been defined, activate it in your build file:

  1. Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>6.8.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.AddRepositoryExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. Run mvn rewrite:run 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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Alex Boyko, Sam Snyder, jdmcmahan, Jonathan Schnéider, Tim te Beek, Patrick Way, Valentin Delaye