Add repository

org.openrewrite.maven.AddRepository

Adds a new Maven Repository or updates a matching repository.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-maven

  • version: 8.21.0

Options

TypeNameDescriptionExample

String

id

A unique name to describe the repository.

String

url

The URL of the repository.

String

repoName

Optional. A display name for the repository.

String

layout

Optional. The Maven layout of the repository.

Boolean

snapshotsEnabled

Optional. Snapshots from the repository are available.

String

snapshotsChecksumPolicy

Optional. Governs whether snapshots require checksums.

String

snapshotsUpdatePolicy

Optional. The policy governing snapshot updating interval.

Boolean

releasesEnabled

Optional. Releases from the repository are available

String

releasesChecksumPolicy

Optional. Governs whether releases require checksums.

String

releasesUpdatePolicy

Optional. The policy governing release updating interval.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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: null
      url: null

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>5.25.0</version>
        <configuration>
          <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

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.

Contributors

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

Last updated