@nx/gradle - Migrations

For an overview of the plugin and setup instructions, see the @nx/gradle introduction.

The @nx/gradle plugin provides various migrations to help you migrate to newer versions of gradle projects within your Nx workspace. Below is a complete reference for all available migrations.

24.0.x

update-24-0-0-migrate-plugin-v1-to-gradle

Version: 24.0.0-beta.0

Replace the removed @nx/gradle/plugin-v1 plugin with @nx/gradle in nx.json, map its options, and apply the dev.nx.gradle.project-graph Gradle plugin.

Replace @nx/gradle/plugin-v1 with @nx/gradle

Nx 24 removes the @nx/gradle/plugin-v1 entry point. This migration switches every @nx/gradle/plugin-v1 registration in nx.json to @nx/gradle. It keeps each registration’s position and its include and exclude patterns.

It also maps the plugin options:

• Renames ciTargetName to ciTestTargetName. An existing ciTestTargetName wins.
• Removes includeSubprojectsTasks, which @nx/gradle doesn’t support.
• Keeps testTargetName, buildTargetName, classesTargetName, and other <taskName>TargetName options.

@nx/gradle reads the project graph from the dev.nx.gradle.project-graph Gradle plugin. The migration applies it in the build.gradle or build.gradle.kts file next to each settings.gradle or settings.gradle.kts file.

Sample code changes

Before

nx.json

{
  "plugins": [
    {
      "plugin": "@nx/gradle/plugin-v1",
      "options": {
        "testTargetName": "test",
        "ciTargetName": "test-ci",
        "includeSubprojectsTasks": false
      }
    }
  ]
}

After

nx.json

{
  "plugins": [
    {
      "plugin": "@nx/gradle",
      "options": {
        "testTargetName": "test",
        "ciTestTargetName": "test-ci"
      }
    }
  ]
}

change-plugin-version-0-1-26

Version: 24.0.0-beta.5

Change dev.nx.gradle.project-graph to version 0.1.26 in build file

Change dev.nx.gradle.project-graph to version 0.1.26

Change dev.nx.gradle.project-graph to version 0.1.26 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.25"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.26"
}

23.2.x

change-plugin-version-0-1-25

Version: 23.2.0-beta.11

Change dev.nx.gradle.project-graph to version 0.1.25 in build file

Change dev.nx.gradle.project-graph to version 0.1.25

Change dev.nx.gradle.project-graph to version 0.1.25 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.24"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.25"
}

23.1.x

change-plugin-version-0-1-23

Version: 23.1.0-beta.4

Change dev.nx.gradle.project-graph to version 0.1.23 in build file

Change dev.nx.gradle.project-graph to version 0.1.23

Change dev.nx.gradle.project-graph to version 0.1.23 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.22"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.23"
}

change-plugin-version-0-1-24

Version: 23.1.0-beta.7

Change dev.nx.gradle.project-graph to version 0.1.24 in build file

Change dev.nx.gradle.project-graph to version 0.1.24

Change dev.nx.gradle.project-graph to version 0.1.24 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.23"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.24"
}

23.0.x

change-plugin-version-0-1-21

Version: 23.0.0-beta.11

Change dev.nx.gradle.project-graph to version 0.1.21 in build file

Change dev.nx.gradle.project-graph to version 0.1.21

Change dev.nx.gradle.project-graph to version 0.1.21 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.20"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.21"
}

update-23-0-0-migrate-create-nodes-v2-import

Version: 23.0.0-beta.24

Rename imports of createNodesV2 from @nx/gradle and @nx/gradle/plugin-v1 to the canonical createNodes export.

Rename createNodesV2 imports to createNodes

@nx/gradle renamed its primary inferred-plugin export from createNodesV2 to createNodes. The createNodesV2 name is preserved as a deprecated alias for now, but new code should use createNodes.

This migration scans every .ts, .tsx, .cts, and .mts file in your workspace and rewrites named imports and re-exports of createNodesV2 from @nx/gradle and @nx/gradle/plugin-v1 to createNodes.

Sample Code Changes

Before

import { createNodesV2 } from '@nx/gradle';

After

import { createNodes } from '@nx/gradle';

Aliases are preserved (createNodesV2 as cn becomes createNodes as cn), and if a file already imports both names ({ createNodes, createNodesV2 }) the redundant binding is dropped.

What is not rewritten

Only static import/export named bindings from @nx/gradle and @nx/gradle/plugin-v1 are rewritten. Namespace imports, dynamic import(...), require(...) destructuring, and property access such as plugin.createNodesV2 are left untouched — they keep working through the createNodesV2 runtime alias. Update those by hand if you want to drop the deprecated name everywhere.

change-plugin-version-0-1-22

Version: 23.0.0-rc.2

Change dev.nx.gradle.project-graph to version 0.1.22 in build file

Change dev.nx.gradle.project-graph to version 0.1.22

Change dev.nx.gradle.project-graph to version 0.1.22 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.21"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.22"
}

22.7.x

change-plugin-version-0-1-16

Version: 22.7.0-beta.2

Change dev.nx.gradle.project-graph to version 0.1.16 in build file

Change dev.nx.gradle.project-graph to version 0.1.16

Change dev.nx.gradle.project-graph to version 0.1.16 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.15"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.16"
}

change-plugin-version-0-1-17

Version: 22.7.0-beta.4

Change dev.nx.gradle.project-graph to version 0.1.17 in build file

Change dev.nx.gradle.project-graph to version 0.1.17

Change dev.nx.gradle.project-graph to version 0.1.17 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.16"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.17"
}

change-plugin-version-0-1-18

Version: 22.7.0-beta.9

Change dev.nx.gradle.project-graph to version 0.1.18 in build file

Change dev.nx.gradle.project-graph to version 0.1.18

Change dev.nx.gradle.project-graph to version 0.1.18 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.17"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.18"
}

change-plugin-version-0-1-19

Version: 22.7.0-beta.11

Change dev.nx.gradle.project-graph to version 0.1.19 in build file

Change dev.nx.gradle.project-graph to version 0.1.19

Change dev.nx.gradle.project-graph to version 0.1.19 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.18"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.19"
}

change-plugin-version-0-1-20

Version: 22.7.0-beta.16

Change dev.nx.gradle.project-graph to version 0.1.20 in build file

Change dev.nx.gradle.project-graph to version 0.1.20

Change dev.nx.gradle.project-graph to version 0.1.20 in build file

Sample Code Changes

Before

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.19"
}

After

build.gradle

plugins {
id "dev.nx.gradle.project-graph" version "0.1.20"
}

22.6.x

change-plugin-version-0-1-14

Version: 22.6.0-beta.11

Change dev.nx.gradle.project-graph to version 0.1.14 in build file

Change dev.nx.gradle.project-graph to version 0.1.14

Change dev.nx.gradle.project-graph to version 0.1.14 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.13"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.14"
}

change-plugin-version-0-1-15

Version: 22.6.0-beta.13

Change dev.nx.gradle.project-graph to version 0.1.15 in build file

Change dev.nx.gradle.project-graph to version 0.1.15

Change dev.nx.gradle.project-graph to version 0.1.15 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.14"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.15"
}

22.5.x

change-plugin-version-0-1-12

Version: 22.5.0-beta.5

Change dev.nx.gradle.project-graph to version 0.1.12 in build file

Change dev.nx.gradle.project-graph to version 0.1.12

Change dev.nx.gradle.project-graph to version 0.1.12 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.11"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.12"
}

change-plugin-version-0-1-13

Version: 22.5.3

Change dev.nx.gradle.project-graph to version 0.1.13 in build file

Change dev.nx.gradle.project-graph to version 0.1.13

Change dev.nx.gradle.project-graph to version 0.1.13 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.12"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.13"
}

22.4.x

change-plugin-version-0-1-11

Version: 22.4.0-beta.2

Change dev.nx.gradle.project-graph to version 0.1.11 in build file

Change dev.nx.gradle.project-graph to version 0.1.11

Change dev.nx.gradle.project-graph to version 0.1.11 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.10"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.11"
}

22.2.x

change-plugin-version-0-1-10

Version: 22.2.0-beta.4

Change dev.nx.gradle.project-graph to version 0.1.10 in build file

Change dev.nx.gradle.project-graph to version 0.1.10

Change dev.nx.gradle.project-graph to version 0.1.10 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.0"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.10"
}

22.1.x

change-plugin-version-0-1-9

Version: 22.1.0-rc.3

Change dev.nx.gradle.project-graph to version 0.1.9 in build file

Change dev.nx.gradle.project-graph to version 0.1.9

Change dev.nx.gradle.project-graph to version 0.1.9 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.0"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.9"
}

21.6.x

change-plugin-version-0-1-8

Version: 21.6.1-beta.2

Change dev.nx.gradle.project-graph to version 0.1.8 in build file

Change dev.nx.gradle.project-graph to version 0.1.8

Change dev.nx.gradle.project-graph to version 0.1.8 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.0"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.8"
}

21.5.x

change-plugin-version-0-1-7

Version: 21.5.1-beta.5

Change dev.nx.gradle.project-graph to version 0.1.7 in build file

Change dev.nx.gradle.project-graph to version 0.1.7

Change dev.nx.gradle.project-graph to version 0.1.7 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.0"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.7"
}

21.4.x

change-plugin-version-0-1-5

Version: 21.4.0-beta.12

Change dev.nx.gradle.project-graph to version 0.1.5 in build file

Change dev.nx.gradle.project-graph to version 0.1.5

Change dev.nx.gradle.project-graph to version 0.1.5 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.0"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.5"
}

change-plugin-version-0-1-6

Version: 21.4.1-beta.1

Change dev.nx.gradle.project-graph to version 0.1.6 in build file

Change dev.nx.gradle.project-graph to version 0.1.6

Change dev.nx.gradle.project-graph to version 0.1.6 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.0"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.6"
}

21.3.x

change-plugin-version-0-1-2

Version: 21.3.0-beta.0

Change dev.nx.gradle.project-graph to version 0.1.2 in build file

Change dev.nx.gradle.project-graph to version 0.1.2

Change dev.nx.gradle.project-graph to version 0.1.2 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.0"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.2"
}

change-plugin-version-0-1-4

Version: 21.3.11-beta.0

Change dev.nx.gradle.project-graph to version 0.1.4 in build file

Change dev.nx.gradle.project-graph to version 0.1.4

Change dev.nx.gradle.project-graph to version 0.1.4 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.1.2"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.4"
}

21.1.x

change-plugin-version-0-1-0

Version: 21.1.2-beta.1

Change dev.nx.gradle.project-graph to version 0.1.0 in build file

Change dev.nx.gradle.project-graph to version 0.1.0

Change dev.nx.gradle.project-graph to version 0.1.0 in build file

Sample Code Changes

Before

build.gradle

plugins {
  id "dev.nx.gradle.project-graph" version "0.0.5"
}

After

build.gradle

plugins {
    id "dev.nx.gradle.project-graph" version "0.1.0"
}

21.0.x

change-plugin-to-v1

Version: 21.0.0-beta.5

Change @nx/gradle plugin to version 1

Change @nx/gradle plugin to @nx/gradle/plugin-v1

Change @nx/gradle plugin to version 1 in nx.json

Sample Code Changes

Before

nx.json

{
  "plugins": ["@nx/gradle"]
}

After

nx.json

{
  "plugins": ["@nx/gradle/plugin-v1"]
}

change-ciTargetName-to-ciTestTargetName

Version: 21.0.0-beta.13

Change @nx/gradle option from ciTargetName to ciTestTargetName

Change @nx/gradle plugin option ciTargetName to ciTestTargetName

Change @nx/gradle plugin option ciTargetName to ciTestTargetName in nx.json

Sample Code Changes

Before

nx.json

{
  "plugins": [
    "plugin": "@nx/gradle",
    "options": {
      "ciTargetName": "ci"
    }
  ]
}

After

nx.json

{
  "plugins": [
    "plugin": "@nx/gradle",
    "options": {
      "ciTestTargetName": "ci"
    }
  ]
}