← All recipes
Moderne licensed

Is GitHub Actions workflow or action definition

Recipe IDorg.openrewrite.github.IsGitHubActionsFileArtifactorg.openrewrite.recipe:rewrite-github-actions

Checks if the file is either a GitHub Actions workflow file, or a GitHub Action definition (action.yml). Steps, and the uses: references within them, appear in both, so prefer this over IsGitHubActionsWorkflow as a precondition for any recipe that operates on steps. Recipes that read workflow-only keys such as on:, permissions:, runs-on: or needs: should keep the narrower IsGitHubActionsWorkflow.

Single recipeMSAL

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.github.IsGitHubActionsFile

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

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

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