Install an orb

org.openrewrite.circleci.InstallOrb
Install a CircleCI orb if it is not already installed.
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-circleci
version: 2.0.4
Options
Type
Name
Description
String
orbKey
The orb key to be followed by an orb slug identifying a specific orb version.
String
slug
A specific orb to install, in the form <namespace>/<orb-name>@1.2.3.
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.InstallOrbExample. 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.InstallOrbExample
displayName: Install an orb example
recipeList:
  - org.openrewrite.circleci.InstallOrb:
      orbKey: kube
      slug: circleci/[email protected]
Now that com.yourorg.InstallOrbExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-circleci:2.0.4 in your build file:
Gradle
Maven
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.3.11")
}
​
rewrite {
    activeRecipe("com.yourorg.InstallOrbExample")
}
​
repositories {
    mavenCentral()
}
​
dependencies {
    rewrite("org.openrewrite.recipe:rewrite-circleci:2.0.4")
}
2.Run gradle rewriteRun to run the recipe.
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.5.2</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.InstallOrbExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-circleci</artifactId>
            <version>2.0.4</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Jonathan Schneider​
​Knut Wannheden​
​Patrick​
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.

Type	Name	Description
`String`	orbKey	The orb key to be followed by an orb slug identifying a specific orb version.
`String`	slug	A specific orb to install, in the form `<namespace>/<orb-name>@1.2.3`.

CircleCI

Update CircleCI image

Last modified 6d ago