← All recipes
Moderne licensed

Change GitHub Action

Recipe IDorg.openrewrite.github.ChangeAction
Artifactorg.openrewrite.recipe:rewrite-github-actions

Change a GitHub Action in any workflow.

Single recipeMSAL

Usage

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

mod run . --recipe org.openrewrite.github.ChangeAction --recipe-option "oldAction=gradle/wrapper-validation-action" --recipe-option "newAction=gradle/actions/wrapper-validation" --recipe-option "newVersion=v3"

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

mod config recipes jar install org.openrewrite.recipe:rewrite-github-actions:3.28.0

Options

NameTypeDescription
oldActionrequiredStringName of the action to match.
e.g. gradle/wrapper-validation-action
oldShaStringRestricts the change by the existing uses: ref. When omitted, the action is changed regardless of how it is pinned (the default; commit SHA pins are rewritten). When set to an empty string, only references that are **not** pinned to a 40-character commit SHA are changed, leaving deliberate SHA pins on the original action untouched. When set to a specific commit SHA, only references pinned to exactly that SHA are changed.
e.g. 8f4b7f84864484a7bf31766abe9204da3cbe65b3
newActionrequiredStringName of the action to use instead.
e.g. gradle/actions/wrapper-validation
newVersionrequiredStringNew version to use.
e.g. v3

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