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: 1.6.0
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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.InstallOrbExample
4
displayName: Install an orb example
5
recipeList:
6
  - org.openrewrite.circleci.InstallOrb:
7
      orbKey: kube
8
      slug: circleci/[email protected]
Copied!
Now that com.yourorg.InstallOrbExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-circleci:1.6.0 in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
    id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
​
5
rewrite {
6
    activeRecipe("com.yourorg.InstallOrbExample")
7
}
8
​
9
repositories {
10
    mavenCentral()
11
}
12
​
13
dependencies {
14
    rewrite("org.openrewrite.recipe:rewrite-circleci:1.6.0")
15
}
Copied!
pom.xml
1
<project>
2
  <build>
3
    <plugins>
4
      <plugin>
5
        <groupId>org.openrewrite.maven</groupId>
6
        <artifactId>rewrite-maven-plugin</artifactId>
7
        <version>4.23.0</version>
8
        <configuration>
9
          <activeRecipes>
10
            <recipe>com.yourorg.InstallOrbExample</recipe>
11
          </activeRecipes>
12
        </configuration>
13
        <dependencies>
14
          <dependency>
15
            <groupId>org.openrewrite.recipe</groupId>
16
            <artifactId>rewrite-circleci</artifactId>
17
            <version>1.6.0</version>
18
          </dependency>
19
        </dependencies>
20
      </plugin>
21
    </plugins>
22
  </build>
23
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.InstallOrbExample

CircleCI

Update CircleCI image

Last modified 5d ago

Export as PDF

Copy link

Contents

Source

Options

Usage