docs(core): add technology-agnostic batch mode guide#34813
Draft
barbados-clemens wants to merge 3 commits intomasterfrom
Draft
docs(core): add technology-agnostic batch mode guide#34813barbados-clemens wants to merge 3 commits intomasterfrom
barbados-clemens wants to merge 3 commits intomasterfrom
Conversation
Add a new guide page explaining batch mode concepts, how to enable it, supported executors, and caching compatibility. Link back from Gradle, Maven, Jest, and TypeScript batch mode pages, and update the inferred tasks page to reference the new guide. Co-Authored-By: Claude Opus 4.6 <[email protected]>
Contributor
|
View your CI Pipeline Execution ↗ for commit b769393
☁️ Nx Cloud last updated this comment at |
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for nx-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![nx-cloud[bot]](https://avatars.githubusercontent.com/in/80458?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
✅ The fix from Nx Cloud was applied automatically
We applied Prettier formatting fixes to batch-mode.mdoc to resolve the astro-docs:format check failure. The changes remove a stray blank line, strip trailing whitespace, and realign the Markdown table column widths to conform to Prettier's code style. These corrections ensure the format task passes without altering any documentation content.
Tip
✅ We verified this fix by re-running astro-docs:format.
Suggested Fix changes
diff --git a/astro-docs/src/content/docs/guides/Tasks & Caching/batch-mode.mdoc b/astro-docs/src/content/docs/guides/Tasks & Caching/batch-mode.mdoc
index c3d67b9eb4..47c3ac339a 100644
--- a/astro-docs/src/content/docs/guides/Tasks & Caching/batch-mode.mdoc
+++ b/astro-docs/src/content/docs/guides/Tasks & Caching/batch-mode.mdoc
@@ -45,15 +45,14 @@ nx run-many -t test --batch
nx run-many -t build --no-batch
```
-
## Supported executors
-If batch mode is turned on but a plugin does not support batch mode, Nx will fall back to the regular executor implementation.
+If batch mode is turned on but a plugin does not support batch mode, Nx will fall back to the regular executor implementation.
-| Executor | Notes |
-| ------------ | --------------------------------------------------------- |
-| `@nx/js:tsc` | Uses TypeScript project references for incremental builds |
-| `@nx/jest` | Batches test compilation across projects |
+| Executor | Notes |
+| ------------ | ------------------------------------------------------------------------------- |
+| `@nx/js:tsc` | Uses TypeScript project references for incremental builds |
+| `@nx/jest` | Batches test compilation across projects |
| `@nx/gradle` | Runs multiple Gradle tasks in a single invocation. Batch mode is on by default. |
| `@nx/maven` | Runs multiple Maven tasks in a single invocation. Batch mode is on by default. |
🔔 Heads up, your workspace has pending recommendations ↗ to auto-apply fixes for similar failures.
🎓 Learn more about Self-Healing CI on nx.dev
Co-authored-by: barbados-clemens <[email protected]>
Add a glossary entry for batch mode and a section on the Run Tasks feature page explaining how to run tasks in batch mode. Co-Authored-By: Claude Opus 4.6 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Current Behavior
Batch mode documentation is scattered across individual technology pages (TypeScript, Gradle, Maven, Jest) with no central guide explaining the concept, how it works, or which executors support it.
Expected Behavior
A new guide page at
guides/tasks--caching/batch-modeprovides a technology-agnostic overview of batch mode, covering:NX_BATCH_MODE=trueenv var and--batchCLI arg)Each technology-specific page now links back to the central guide for the full explanation.
Related Issue(s)
Fixes #DOC-420
🤖 Generated with Claude Code