Update git resource source.uri references

org.openrewrite.concourse.UpdateGitResourceUri

Update git resource source.uri URI values to point to a new URI value.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-concourse

  • version: 2.1.7

Options

TypeNameDescriptionExample

String

oldURIPattern

Optional. The old URI value to replace. This can be a regex pattern. If left empty, replace all occurrences.

https://github.com/openrewrite/rewrite

String

newURI

New URI value to replace the old URI value with.

git@gitlab.com:openrewrite/rewrite.git

String

fileMatcher

Optional. Matching files will be modified. This is a glob expression.

**/pipeline*.yml

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.UpdateGitResourceUriExample. 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.UpdateGitResourceUriExample
displayName: Update git resource `source.uri` references example
recipeList:
  - org.openrewrite.concourse.UpdateGitResourceUri:
      oldURIPattern: https://github.com/openrewrite/rewrite
      newURI: git@gitlab.com:openrewrite/rewrite.git
      fileMatcher: '**/pipeline*.yml'

Now that com.yourorg.UpdateGitResourceUriExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-concourse:2.1.7 in your build file:

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.11.2")
}

rewrite {
    activeRecipe("com.yourorg.UpdateGitResourceUriExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-concourse:2.1.7")
}
  1. Run gradle rewriteRun to run the recipe.

Definition

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

Jonathan Schneider, Kun Li, Aaron Gershman

Last updated