Install an orb
org.openrewrite.circleci.InstallOrb
- groupId: org.openrewrite.recipe
- artifactId: rewrite-circleci
- version: 1.20.0
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. |
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:1.20.0 in your build file:Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.40.4")
}
rewrite {
activeRecipe("com.yourorg.InstallOrbExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-circleci:1.20.0")
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.45.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.InstallOrbExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-circleci</artifactId>
<version>1.20.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
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.
Last modified 23d ago