← All recipes
Moderne licensed

Remove a runner from a job

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

Removes a runner label from the runs-on of a job, leaving the remaining runner labels untouched. Both sequences (runs-on: [self-hosted, linux]) and the labels of a runner group are supported. The runner is never removed when it is the only one left, as a job requires at least one runner.

Single recipeMSAL

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.RemoveRunner")
}

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.33.0")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

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

mod run . --recipe org.openrewrite.github.RemoveRunner --recipe-option "jobName=build" --recipe-option "runner=self-hosted"

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

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

Options

NameTypeDescription
jobNamerequiredStringThe name of the job to update, use * to affect all the workflow jobs.
e.g. build
runnerrequiredStringThe runner label to remove. Labels are compared case-insensitively, as GitHub does.
e.g. self-hosted

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