Skip to main content

Change Docker FROM

org.openrewrite.docker.ChangeFrom

Change the base image in a Dockerfile FROM instruction.

Recipe source​

GitHub: ChangeFrom.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringoldImageNameGlob pattern to match image names (without tag/digest).ubuntu
StringoldTagOptional. Only match images with tags matching this glob pattern. If null, matches any tag or no tag.20.*
StringoldDigestOptional. Only match images with digests matching this glob pattern. If null, matches any digest or no digest.sha256:*
StringoldPlatformOptional. Only change images with this platform. If null, matches any platform.linux/amd64
StringnewImageNameOptional. The new image name. If null, preserves the existing name.ubuntu
StringnewTagOptional. The new tag. If null, preserves the existing tag. If empty, removes the tag.22.04
StringnewDigestOptional. The new digest. If null, preserves the existing digest. If empty, removes the digest.sha256:abc123...
StringnewPlatformOptional. The new platform. If null, preserves the existing platform. If empty, removes the platform flag.linux/arm64

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.ChangeFromExample. 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.ChangeFromExample
displayName: Change Docker FROM example
recipeList:
  - org.openrewrite.docker.ChangeFrom:
      oldImageName: ubuntu
      oldTag: 20.*
      oldDigest: sha256:*
      oldPlatform: linux/amd64
      newImageName: ubuntu
      newTag: 22.04
      newDigest: sha256:abc123...
      newPlatform: linux/arm64

Now that com.yourorg.ChangeFromExample has been defined, activate it and take a dependency on org.openrewrite:rewrite-docker:8.73.0 in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("com.yourorg.ChangeFromExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite:rewrite-docker:8.73.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.