feat(core): accept various task runner options from root of nx.json #19243

AgentEnder · 2023-09-19T20:55:07Z

Current Behavior

tasksRunnerOptions is a required property for most workspaces, even though they only have 1 runner.

Expected Behavior

This PR simplifies the configuration by allowing most properties to instead be read from the root of the nx.json. One property which changes notably is that cacheableOperations's default value is inferred from the value of cache: true in targetDefaults.

This PR also lays the groundwork for allowing specification of cache: true in a project.json file or similar, but it is hidden behind an env variable until other runners (notably nx cloud) support the property.

Related Issue(s)

Fixes #

vercel · 2023-09-19T20:55:10Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 5, 2023 2:33pm

nx-cloud · 2023-09-19T20:56:54Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9704f7b. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 6 targets

Sent with 💌 from NxCloud.

JamesHenry · 2023-09-20T08:49:14Z

packages/nx/src/config/nx-json.ts

+   * If specified Nx will use nx-cloud by default with the given token.
+   * To use a different runner that accepts an access token, define it in {@link tasksRunnerOptions}
+   */
+  accessToken?: string;


What do you think about nxCloudAccessToken or cloudAccessToken instead?

I don't think accessToken by itself at the root is self-documenting enough for someone who isn't intimately familiar with our ecosystem

Happy to chat about it, I think its fine though as we will update the schemas to have intellisense and the docs will also show it.

I'm okay with nxCloudAccessToken but I'll defer to @vsavkin .

Victor is as well. Changing it.

packages/nx/src/daemon/client/client.ts

packages/nx/src/tasks-runner/run-command.ts

packages/nx/src/tasks-runner/utils.ts

packages/nx/src/utils/nx-cloud-utils.ts

packages/nx/src/config/nx-json.ts

FrozenPandaz · 2023-10-03T18:15:32Z

packages/nx/src/config/nx-json.ts

+   * If specified Nx will use nx-cloud by default with the given token.
+   * To use a different runner that accepts an access token, define it in {@link tasksRunnerOptions}
+   */
+  accessToken?: string;


I'm okay with nxCloudAccessToken but I'll defer to @vsavkin .

FrozenPandaz · 2023-10-03T18:16:20Z

packages/nx/src/config/nx-json.ts

+  parallel?: number;
+
+  /**
+   * Changes the default location of the cache directory.


Suggested change

* Changes the default location of the cache directory.

* Changes the directory used by Nx to store its cache.

FrozenPandaz · 2023-10-03T18:17:41Z

packages/nx/src/config/nx-json.ts

+  accessToken?: string;
+
+  /**
+   * Specifies how many tasks are ran in parallel by Nx for the default tasks runner.


Suggested change

* Specifies how many tasks are ran in parallel by Nx for the default tasks runner.

* Specifies how many tasks can be run in parallel.

FrozenPandaz · 2023-10-03T18:18:52Z

packages/nx/src/config/nx-json.ts

+  cacheDirectory?: string;
+
+  /**
+   * Allows turning the daemon off if set to false explicitly.


Suggested change

* Allows turning the daemon off if set to false explicitly.

* Set this to false to disable the daemon

FrozenPandaz · 2023-10-03T18:20:48Z

docs/generated/devkit/TargetConfiguration.md

@@ -23,6 +24,15 @@ Target's configuration

 ## Properties

+### cache


Move this typing definitino to TargetDefaults for now.

FrozenPandaz · 2023-10-03T18:23:11Z

packages/nx/src/daemon/client/client.ts

@@ -64,7 +64,9 @@ export class DaemonClient {

  enabled() {
    if (this._enabled === undefined) {
+      // TODO: Add migration to move it out of existing configs and remove the ?? here.


Suggested change

// TODO: Add migration to move it out of existing configs and remove the ?? here.

// TODO(v18): Add migration to move it out of existing configs and remove the ?? here.

FrozenPandaz · 2023-10-03T18:33:02Z

packages/nx/src/tasks-runner/run-command.ts

+  if (nxJson.accessToken) {
+    result.accessToken ??= nxJson.accessToken;
+  }


ONLY send this in if nx-cloud is used.

github-actions · 2023-10-11T00:06:57Z

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

vercel bot deployed to Preview September 19, 2023 21:00 View deployment

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from c824db4 to 03c49ac Compare September 19, 2023 21:56

vercel bot deployed to Preview September 19, 2023 22:01 View deployment

JamesHenry reviewed Sep 20, 2023

View reviewed changes

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from 03c49ac to 0b39499 Compare September 20, 2023 20:31

vercel bot deployed to Preview September 20, 2023 20:38 View deployment

AgentEnder marked this pull request as ready for review September 20, 2023 22:00

AgentEnder requested review from a team as code owners September 20, 2023 22:00

AgentEnder requested a review from vsavkin September 20, 2023 22:00

FrozenPandaz requested changes Sep 22, 2023

View reviewed changes

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from 0b39499 to d7c234c Compare September 23, 2023 03:23

AgentEnder requested a review from leosvelperez as a code owner September 23, 2023 03:23

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from d7c234c to 6c20939 Compare September 27, 2023 14:11

AgentEnder requested a review from FrozenPandaz September 28, 2023 14:14

FrozenPandaz requested changes Oct 3, 2023

View reviewed changes

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from 6c20939 to 452946f Compare October 3, 2023 20:51

vercel bot deployed to Preview October 3, 2023 20:57 View deployment

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from 452946f to da28015 Compare October 3, 2023 21:41

vercel bot deployed to Preview October 3, 2023 21:47 View deployment

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from da28015 to d140b5e Compare October 4, 2023 14:35

vercel bot deployed to Preview October 4, 2023 14:41 View deployment

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from d140b5e to 3cb5d27 Compare October 4, 2023 17:49

vercel bot deployed to Preview October 4, 2023 17:55 View deployment

FrozenPandaz approved these changes Oct 5, 2023

View reviewed changes

AgentEnder added 2 commits October 5, 2023 10:23

feat(core): accept various task runner options from root of nx.json

cd79e4e

chore(core): misc cleanup

9704f7b

AgentEnder force-pushed the feat/accept-task-runner-options-from-root-level branch from 3cb5d27 to 9704f7b Compare October 5, 2023 14:28

vercel bot deployed to Preview October 5, 2023 14:33 View deployment

FrozenPandaz approved these changes Oct 5, 2023

View reviewed changes

FrozenPandaz merged commit 9474841 into nrwl:master Oct 5, 2023
6 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Oct 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): accept various task runner options from root of nx.json #19243

feat(core): accept various task runner options from root of nx.json #19243

AgentEnder commented Sep 19, 2023

vercel bot commented Sep 19, 2023 •

edited

Loading

nx-cloud bot commented Sep 19, 2023 •

edited

Loading

JamesHenry Sep 20, 2023 •

edited

Loading

AgentEnder Sep 20, 2023

FrozenPandaz Oct 3, 2023

AgentEnder Oct 3, 2023

FrozenPandaz Oct 3, 2023

FrozenPandaz Oct 3, 2023

FrozenPandaz Oct 3, 2023

FrozenPandaz Oct 3, 2023

FrozenPandaz Oct 3, 2023

FrozenPandaz Oct 3, 2023

FrozenPandaz Oct 3, 2023

github-actions bot commented Oct 11, 2023

	* Changes the default location of the cache directory.
	* Changes the directory used by Nx to store its cache.

	* Specifies how many tasks are ran in parallel by Nx for the default tasks runner.
	* Specifies how many tasks can be run in parallel.

	* Allows turning the daemon off if set to false explicitly.
	* Set this to false to disable the daemon

		@@ -23,6 +24,15 @@ Target's configuration

		## Properties

		### cache

	// TODO: Add migration to move it out of existing configs and remove the ?? here.
	// TODO(v18): Add migration to move it out of existing configs and remove the ?? here.

feat(core): accept various task runner options from root of nx.json #19243

feat(core): accept various task runner options from root of nx.json #19243

Conversation

AgentEnder commented Sep 19, 2023

Current Behavior

Expected Behavior

Related Issue(s)

vercel bot commented Sep 19, 2023 • edited Loading

nx-cloud bot commented Sep 19, 2023 • edited Loading

☁️ Nx Cloud Report

JamesHenry Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 11, 2023

vercel bot commented Sep 19, 2023 •

edited

Loading

nx-cloud bot commented Sep 19, 2023 •

edited

Loading

JamesHenry Sep 20, 2023 •

edited

Loading