← All recipes
Moderne licensed

Add open-pull-requests-limit to Dependabot configuration

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

Adds an open-pull-requests-limit to each update configuration in Dependabot files, and replaces an existing value when it differs. The option caps the number of version update pull requests Dependabot keeps open; setting it to 0 temporarily disables version updates for that package-ecosystem. Security update pull requests are not subject to this limit and do not count towards it. The available configuration options for dependabot are listed on GitHub.

Single recipegithubdependabotdependenciesMSAL

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

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

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.AddDependabotOpenPullRequestsLimit --recipe-option "openPullRequestsLimit=5"

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

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

Options

NameTypeDescription
openPullRequestsLimitrequiredIntegerThe maximum number of version update pull requests Dependabot keeps open for an update configuration. Set to 0 to temporarily disable version updates for the matched entries. Security update pull requests are not subject to this limit.
e.g. 5
packageEcosystemStringRestrict the change to a single package-ecosystem, for example gradle. When omitted, every update configuration is changed.
e.g. gradle

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