GitHub Actions best practices
Recipe ID
org.openrewrite.github.GitHubActionsBestPracticesArtifact
org.openrewrite.recipe:rewrite-github-actionsApplies best practices to GitHub Actions workflows, including enabling dependency caching, using cached distributions, finding missing timeouts, removing unused inputs, preferring block-style job dependencies, and upgrading official actions to their latest versions.
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.GitHubActionsBestPracticesIf the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-github-actions:3.28.0Definition
This recipe runs the following recipes in order.
- Find jobs missing timeout
org.openrewrite.github.FindMissingTimeout - Prefer block style for job dependencies
org.openrewrite.github.PreferBlockStyleJobDependencies - Use
actions/setup-javatemurindistribution as they are cached in hosted runnersorg.openrewrite.github.PreferTemurinDistributions - Remove unused workflow dispatch inputs
org.openrewrite.github.RemoveUnusedWorkflowDispatchInputs - Setup Java dependency caching
org.openrewrite.github.SetupJavaCaching - Upgrade official GitHub Actions to their latest versions
org.openrewrite.github.UpgradeOfficialGitHubActions
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