updategitresourceuri.md

Update git resource source.uri references

org.openrewrite.concourse.UpdateGitResourceUri

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

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-concourse
• version: 2.0.1

Options

Type	Name	Description
String	oldURIPattern	Optional. The old URI value to replace. This can be a regex pattern. If left empty, replace all occurrences.
String	newURI	New URI value to replace the old URI value with.
String	fileMatcher	Optional. Matching files will be modified. This is a glob expression.

Example

Parameters

Parameter	Value
oldURIPattern	https://github.com/openrewrite/rewrite0
newURI	[email protected]:openrewrite/rewrite1.git
fileMatcher	null

{% tabs %} {% tab title="yaml" %}

Before

{% code %}

resources:
- name: git-repo
  type: git
  source:
    uri: https://github.com/openrewrite/rewrite0
- name: custom
  type: custom-type
  source:
    uri: https://github.com/openrewrite/rewrite0

{% endcode %}

After

{% code %}

resources:
- name: git-repo
  type: git
  source:
    uri: [email protected]:openrewrite/rewrite1.git
- name: custom
  type: custom-type
  source:
    uri: https://github.com/openrewrite/rewrite0

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -5,1 +5,1 @@
  type: git
  source:
-   uri: https://github.com/openrewrite/rewrite0
+   uri: [email protected]:openrewrite/rewrite1.git
- name: custom

{% endcode %} {% endtab %} {% endtabs %}

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:

{% code title="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: [email protected]:openrewrite/rewrite.git
      fileMatcher: '**/pipeline*.yml'

{% endcode %}

Now that com.yourorg.UpdateGitResourceUriExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-concourse:2.0.1 in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

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

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-concourse:2.0.1")
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.UpdateGitResourceUriExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-concourse</artifactId>
            <version>2.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Definition

{% tabs %} {% tab title="Recipe List" %}

• Change Concourse value
  • keyPath: $.resources[?(@.type == 'git')].source.uri
  • oldValue: ``
  • newValue: ``
  • fileMatcher: ``

{% endtab %}

{% tab title="Yaml Recipe List" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.concourse.UpdateGitResourceUri
displayName: Update git resource `source.uri` references
description: Update git resource `source.uri` URI values to point to a new URI value.
oldURIPattern: 

newURI: 

fileMatcher: 

recipeList:
  - org.openrewrite.concourse.ChangeValue:
      keyPath: $.resources[?(@.type == 'git')].source.uri
      oldValue: 
      newValue: 
      fileMatcher: 

{% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• Kun Li
• Aaron Gershman

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.