← All recipes
Open source

Add Docker LABEL instruction

Recipe IDorg.openrewrite.docker.AddOrUpdateLabel
Artifactorg.openrewrite:rewrite-docker

Adds or updates a LABEL instruction in a Dockerfile. By default, adds to the final stage only.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.docker.AddOrUpdateLabel --recipe-option "key=org.opencontainers.image.version" --recipe-option "value=1.0.0"

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

mod config recipes jar install org.openrewrite:rewrite-docker:8.88.0

Options

NameTypeDescription
keyrequiredStringThe key of the label to add.
e.g. org.opencontainers.image.version
valuerequiredStringThe value of the label.
e.g. 1.0.0
overwriteExistingBooleanIf true, overwrite the label if it already exists. If false, skip if exists. Defaults to true.
stageNameStringOnly add the label to this build stage. If null, adds to the final stage only.
e.g. final

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