Add workflow rules
Recipe ID
org.openrewrite.gitlab.AddWorkflowRulesArtifactorg.openrewrite.recipe:rewrite-gitlabAdd workflow:rules to .gitlab-ci.yml to control pipeline creation.
Composite recipeMSAL
Add to your build
Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.
~/.gradle/gradle.properties
codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN
build.gradle.kts
plugins {
id("org.openrewrite.rewrite") version("latest.release")
}
rewrite {
activeRecipe("org.openrewrite.gitlab.AddWorkflowRules")
}
repositories {
mavenCentral()
maven {
url = uri("https://artifacts.codegenomeproject.org/maven")
credentials {
username = providers.gradleProperty("codeGenomeUsername").get()
password = providers.gradleProperty("codeGenomeToken").get()
}
}
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-gitlab:0.25.1")
}
Then run
./gradlew rewriteRunThis recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.gitlab.AddWorkflowRules --recipe-option "rules=- if: $CI_PIPELINE_SOURCE == 'merge_request_event'\n- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS\n when: never\n- if: $CI_COMMIT_BRANCH"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-gitlab:RELEASEOptions
| Name | Type | Description |
|---|---|---|
rulesrequired | String | The YAML snippet defining the workflow rules. e.g. - if: $CI_PIPELINE_SOURCE == 'merge_request_event'\n- if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS\n when: never\n- if: $CI_COMMIT_BRANCH |
acceptTheirs | Boolean | When workflow rules already exist, prefer the original value. |
Definition
This recipe runs the following recipes in order.
- Merge YAML snippet at
$org.openrewrite.yaml.MergeYaml
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats