← All recipes
Moderne licensed

Replace GitHub Action secret names

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

Replace references to GitHub Action secrets in workflow files.

Single recipeMSAL

Usage

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

mod run . --recipe org.openrewrite.github.ReplaceSecrets --recipe-option "oldSecretName=OSSRH_S01_USERNAME" --recipe-option "newSecretName=SONATYPE_USERNAME"

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
oldSecretNamerequiredStringThe name of the secret to be replaced
e.g. OSSRH_S01_USERNAME
newSecretNamerequiredStringThe new secret name to use
e.g. SONATYPE_USERNAME
fileMatcherStringOptional file path matcher
e.g. .github/workflows/*.{yml,yaml}

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