Skip to content

Commit

Permalink
docs(core): apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Leosvel Pérez Espinosa <leosvel.perez.espinosa@gmail.com>
  • Loading branch information
isaacplmann and leosvelperez committed Apr 23, 2024
1 parent 9143671 commit 14c2454
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/shared/tutorials/gradle.md
Expand Up @@ -96,9 +96,9 @@ BUILD SUCCESSFUL in 3s

## Add Nx

With the `@nx/gradle` plugin, Nx can be easily added to a Gradle repository and Nx will work seamlessly along side Gradle.
With the `@nx/gradle` plugin, Nx can be easily added to a Gradle repository and Nx will work seamlessly alongside Gradle.

Nx offers many features, but at its core, it is a task runner. Out of the box, it can cache your tasks and ensure those tasks are run in the correct order. After the initial set up, you can incrementally add on other features that would be helpful in your organization.
Nx offers many features, but at its core, it is a task runner. Out of the box, it can cache your tasks and ensure those tasks are run in the correct order. After the initial setup, you can incrementally add other features that would be helpful in your organization.

To enable Nx in your repository, run a single command:

Expand Down Expand Up @@ -126,7 +126,7 @@ gradle-tutorial/
└── settings.gradle.kts
```

Because this is not a javascript repository, there is no `package.json` file or `node_modules` folder. Instead, Nx has provided executables at the root of the repository: `nx` for Unix operating systems and `nx.bat` for Windows. These executables can be used in the same way that `gradlew` and `gradlew.bat` are used.
Because this is not a JavaScript repository, there is no `package.json` file or `node_modules` folder. Instead, Nx has provided executables at the root of the repository: `nx` for Unix operating systems and `nx.bat` for Windows. These executables can be used in the same way that `gradlew` and `gradlew.bat` are used.

The `.nx` folder contains all the code needed to run the `nx` CLI and the cache that Nx uses.

Expand Down Expand Up @@ -262,11 +262,11 @@ Then you can use the `nx affected` command to run the `assemble` task only for p
./nx affected -t assemble
```

The assemble task was run for the `app` project, but not for `list` or `utilities` because a change to the `app` project could not have changed the behavior of those projects. This feature is most useful in CI where you want to make sure to fully check every project that may have been affected by a change, but you want to avoid wasting time on tasks that do not need to be run. As more projects are added to the repository, this functionality becomes essential to maintain a fast CI pipeline.
The `assemble` task was run for the `app` project, but not for `list` or `utilities` because a change to the `app` project could not have changed the behavior of those projects. This feature is most useful in CI where you want to make sure to fully check every project that may have been affected by a change, but you want to avoid wasting time on tasks that do not need to be run. As more projects are added to the repository, this functionality becomes essential to maintain a fast CI pipeline.

## Summary

Now that you have added Nx to your Gradle repository, you can take advantage of Nx's dependency graph visualisation and leverage the `affected` command to speed up your CI pipeline. You can also more easily add javascript projects along side your Gradle projects and use Nx to manage them all.
Now that you have added Nx to your Gradle repository, you can take advantage of Nx's dependency graph visualisation and leverage the `affected` command to speed up your CI pipeline. You can also more easily add JavaScript projects alongside your Gradle projects and use Nx to manage them all.

## Setup CI for Your Gradle Repository

Expand Down

0 comments on commit 14c2454

Please sign in to comment.