Moderne licensed

GitLab CI best practices

Recipe IDorg.openrewrite.gitlab.BestPracticesArtifactorg.openrewrite.recipe:rewrite-gitlab

Apply GitLab CI/CD best practices to .gitlab-ci.yml. This includes adding workflow:rules to prevent duplicate pipelines, setting interruptible: true and retry in the default section, configuring artifacts:expire_in, and setting a job timeout.

Composite recipegitlabciMSAL

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.BestPractices")
}

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 rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.gitlab.BestPractices

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-gitlab:RELEASE

Definition

This recipe runs the following recipes in order.

Migrate only/except to rulesorg.openrewrite.gitlab.MigrateToRules
Add workflow rules - if: $CI_PIPELINE_SOURCE == 'merge_request_event' - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS when: never - if: $CI_COMMIT_BRANCHorg.openrewrite.gitlab.AddWorkflowRules
Add interruptibleorg.openrewrite.gitlab.AddInterruptible
Add retry configuration 2org.openrewrite.gitlab.AddRetry
Add artifacts expire_in 1 weekorg.openrewrite.gitlab.AddArtifactsExpireIn
Add job timeout 1 hourorg.openrewrite.gitlab.AddTimeout

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