Moderne licensed

GitHub Actions best practices

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

Applies 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.

Composite recipeactionsgithubMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.github.GitHubActionsBestPractices")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-github-actions:3.32.0")
}

Then run

./gradlew rewriteRun

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.GitHubActionsBestPractices

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

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

Definition

This recipe runs the following recipes in order.

Find jobs missing timeoutorg.openrewrite.github.FindMissingTimeout
Prefer block style for job dependenciesorg.openrewrite.github.PreferBlockStyleJobDependencies
Use actions/setup-java temurin distribution as they are cached in hosted runnersorg.openrewrite.github.PreferTemurinDistributions
Remove unused workflow dispatch inputsorg.openrewrite.github.RemoveUnusedWorkflowDispatchInputs
Setup Java dependency cachingorg.openrewrite.github.SetupJavaCaching
Upgrade official GitHub Actions to their latest versionsorg.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