Skip to main content

Replace Dependabot reviewers with CODEOWNERS

org.openrewrite.github.ReplaceDependabotReviewersWithCodeowners

Replaces the removed reviewers option in .github/dependabot.yml with equivalent CODEOWNERS entries. Each reviewer is mapped onto the manifest files Dependabot updates for that package-ecosystem and directory, so ownership stays as narrow as the Dependabot configuration was. Update entries whose package-ecosystem has no known manifests are left untouched.

Tags​

Recipe source​

GitHub: ReplaceDependabotReviewersWithCodeowners.java, Issue Tracker, Code Genome Project

This recipe is available under the Moderne Source Available License. Moderne customers can download precompiled artifacts from The Code Genome Project. For non-commercial use you can build the artifact from source locally.

Options​

TypeNameDescriptionExample
StringcodeownersPathOptional. Where to write the migrated reviewers when the repository does not have a CODEOWNERS file yet. Defaults to .github/CODEOWNERS. When a CODEOWNERS file already exists in any of the locations GitHub recognizes, that file is appended to instead and this option is ignored.CODEOWNERS

Example​

Parameters​
ParameterValue
codeownersPathnull
Before​
.github/dependabot.yml
version: 2
updates:
  - package-ecosystem: maven
    directory: /
    schedule:
      interval: weekly
    reviewers:
      - acme/backend
  - package-ecosystem: npm
    directory: /frontend
    schedule:
      interval: weekly
    reviewers:
      - acme/frontend
After​
.github/dependabot.yml
version: 2
updates:
  - package-ecosystem: maven
    directory: /
    schedule:
      interval: weekly
  - package-ecosystem: npm
    directory: /frontend
    schedule:
      interval: weekly

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on `org.openrewrite.recipe:rewrite-github-actions` in your build file or by running a shell command (in which case no build changes are needed):

OpenRewrite artifacts are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token, then in the snippets below replace USERNAME with the email or username you signed in with and TOKEN with that token. See the quickstart guide for details.

  1. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("org.openrewrite.github.ReplaceDependabotReviewersWithCodeowners")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = "USERNAME"
                password = "TOKEN"
            }
        }
    }

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-github-actions:3.30.0")
    }
  2. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.