← All recipes
Moderne licensed

Migrate GitLab template to component

Recipe IDorg.openrewrite.gitlab.MigrateTemplateToComponent
Artifactorg.openrewrite.recipe:rewrite-gitlab

Replace a GitLab template: include with a component: include, as recommended by GitLab's CI/CD Catalog migration guides.

Single recipeMSAL

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.gitlab.MigrateTemplateToComponent --recipe-option "oldTemplate=Terraform/Base.latest.gitlab-ci.yml" --recipe-option "newComponent=$CI_SERVER_FQDN/components/opentofu/job-templates" --recipe-option "version=~latest"

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

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

Options

NameTypeDescription
oldTemplaterequiredStringThe name of the template to replace.
e.g. Terraform/Base.latest.gitlab-ci.yml
newComponentrequiredStringName of the component to use instead.
e.g. $CI_SERVER_FQDN/components/opentofu/job-templates
versionrequiredStringVersion of the component to add.
e.g. ~latest
inputsListThe set of inputs to provide to the component.
e.g. opentofu_version: 1.6.0

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