@nx/workspace 21.2.1 → 21.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -3
- package/src/generators/ci-workflow/ci-workflow.d.ts +6 -0
- package/src/generators/ci-workflow/ci-workflow.js +110 -1
- package/src/generators/ci-workflow/files/azure/azure-pipelines.yml__tmpl__ +13 -14
- package/src/generators/ci-workflow/files/bitbucket-pipelines/bitbucket-pipelines.yml__tmpl__ +23 -12
- package/src/generators/ci-workflow/files/circleci/.circleci/config.yml__tmpl__ +8 -8
- package/src/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml__tmpl__ +7 -8
- package/src/generators/ci-workflow/files/gitlab/.gitlab-ci.yml__tmpl__ +13 -8
- package/src/generators/ci-workflow/schema.json +6 -0
- package/src/generators/move/lib/create-project-configuration-in-new-destination.js +4 -2
- package/src/generators/move/lib/update-imports.js +2 -1
- package/src/generators/new/new.d.ts +6 -6
- package/src/generators/new/schema.json +4 -10
- package/src/generators/preset/schema.d.ts +5 -5
- package/src/generators/preset/schema.json +4 -11
- package/src/generators/utils/project-config.d.ts +2 -0
- package/src/generators/utils/project-config.js +18 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nx/workspace",
|
|
3
|
-
"version": "21.2.
|
|
3
|
+
"version": "21.2.3",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.",
|
|
6
6
|
"repository": {
|
|
@@ -38,14 +38,14 @@
|
|
|
38
38
|
}
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@nx/devkit": "21.2.
|
|
41
|
+
"@nx/devkit": "21.2.3",
|
|
42
42
|
"@zkochan/js-yaml": "0.0.7",
|
|
43
43
|
"chalk": "^4.1.0",
|
|
44
44
|
"enquirer": "~2.3.6",
|
|
45
45
|
"picomatch": "4.0.2",
|
|
46
46
|
"tslib": "^2.3.0",
|
|
47
47
|
"yargs-parser": "21.1.1",
|
|
48
|
-
"nx": "21.2.
|
|
48
|
+
"nx": "21.2.3"
|
|
49
49
|
},
|
|
50
50
|
"publishConfig": {
|
|
51
51
|
"access": "public"
|
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
import { Tree } from '@nx/devkit';
|
|
2
|
+
export type Command = {
|
|
3
|
+
command?: string;
|
|
4
|
+
comments?: string[];
|
|
5
|
+
alwaysRun?: boolean;
|
|
6
|
+
};
|
|
2
7
|
export interface Schema {
|
|
3
8
|
name: string;
|
|
4
9
|
ci: 'github' | 'azure' | 'circleci' | 'bitbucket-pipelines' | 'gitlab';
|
|
10
|
+
useRunMany?: boolean;
|
|
5
11
|
}
|
|
6
12
|
export declare function ciWorkflowGenerator(tree: Tree, schema: Schema): Promise<void>;
|
|
@@ -6,6 +6,107 @@ const default_base_1 = require("../../utilities/default-base");
|
|
|
6
6
|
const path_1 = require("path");
|
|
7
7
|
const nx_cloud_utils_1 = require("nx/src/utils/nx-cloud-utils");
|
|
8
8
|
const ts_solution_setup_1 = require("../../utilities/typescript/ts-solution-setup");
|
|
9
|
+
function getNxCloudRecordCommand(ci, packageManagerPrefix) {
|
|
10
|
+
const baseCommand = `${packageManagerPrefix} nx-cloud record -- echo Hello World`;
|
|
11
|
+
const prefix = getCiPrefix(ci);
|
|
12
|
+
const exampleComment = `${prefix}${baseCommand}`;
|
|
13
|
+
return {
|
|
14
|
+
comments: [
|
|
15
|
+
`Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud`,
|
|
16
|
+
exampleComment,
|
|
17
|
+
],
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
function getNxTasksCommand(ci, packageManagerPrefix, mainBranch, hasTypecheck, hasE2E, useRunMany = false) {
|
|
21
|
+
const tasks = `lint test build${hasTypecheck ? ' typecheck' : ''}${hasE2E ? ' e2e' : ''}`;
|
|
22
|
+
const commandType = useRunMany ? 'run-many' : 'affected';
|
|
23
|
+
const nxCommandComments = useRunMany
|
|
24
|
+
? [
|
|
25
|
+
`As your workspace grows, you can change this to use Nx Affected to run only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
|
|
26
|
+
]
|
|
27
|
+
: [
|
|
28
|
+
`Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
|
|
29
|
+
];
|
|
30
|
+
if (hasE2E) {
|
|
31
|
+
nxCommandComments.push(`When you enable task distribution, run the e2e-ci task instead of e2e`);
|
|
32
|
+
}
|
|
33
|
+
const args = getCiArgs(ci, mainBranch, useRunMany);
|
|
34
|
+
const nxCommand = `${packageManagerPrefix} nx ${commandType} ${args}-t ${tasks}`;
|
|
35
|
+
return {
|
|
36
|
+
comments: nxCommandComments,
|
|
37
|
+
command: nxCommand,
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
function getNxCloudFixCiCommand(packageManagerPrefix) {
|
|
41
|
+
return {
|
|
42
|
+
comments: [
|
|
43
|
+
`Nx Cloud recommends fixes for failures to help you get CI green faster. Learn more: https://nx.dev/ci/features/self-healing-ci`,
|
|
44
|
+
],
|
|
45
|
+
command: `${packageManagerPrefix} nx fix-ci`,
|
|
46
|
+
alwaysRun: true,
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
function getCiCommands(ci, packageManagerPrefix, mainBranch, hasTypecheck, hasE2E, useRunMany = false) {
|
|
50
|
+
return [
|
|
51
|
+
getNxCloudRecordCommand(ci, packageManagerPrefix),
|
|
52
|
+
getNxTasksCommand(ci, packageManagerPrefix, mainBranch, hasTypecheck, hasE2E, useRunMany),
|
|
53
|
+
getNxCloudFixCiCommand(packageManagerPrefix),
|
|
54
|
+
];
|
|
55
|
+
}
|
|
56
|
+
function getCiPrefix(ci) {
|
|
57
|
+
if (ci === 'github' || ci === 'circleci') {
|
|
58
|
+
return '- run: ';
|
|
59
|
+
}
|
|
60
|
+
else if (ci === 'azure') {
|
|
61
|
+
return '- script: ';
|
|
62
|
+
}
|
|
63
|
+
else if (ci === 'gitlab') {
|
|
64
|
+
return '- ';
|
|
65
|
+
}
|
|
66
|
+
// Bitbucket expects just the command without prefix for pull requests
|
|
67
|
+
return '';
|
|
68
|
+
}
|
|
69
|
+
function getCiArgs(ci, mainBranch, useRunMany = false) {
|
|
70
|
+
// When using run-many, we don't need base/head SHA args
|
|
71
|
+
if (useRunMany) {
|
|
72
|
+
return '';
|
|
73
|
+
}
|
|
74
|
+
if (ci === 'azure') {
|
|
75
|
+
return '--base=$(BASE_SHA) --head=$(HEAD_SHA) ';
|
|
76
|
+
}
|
|
77
|
+
else if (ci === 'bitbucket-pipelines') {
|
|
78
|
+
return `--base=origin/${mainBranch} `;
|
|
79
|
+
}
|
|
80
|
+
return '';
|
|
81
|
+
}
|
|
82
|
+
function getBitbucketBranchCommands(packageManagerPrefix, hasTypecheck, hasE2E, useRunMany = false) {
|
|
83
|
+
const tasks = `lint test build${hasTypecheck ? ' typecheck' : ''}${hasE2E ? ' e2e-ci' : ''}`;
|
|
84
|
+
const nxCloudComments = [
|
|
85
|
+
`Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud`,
|
|
86
|
+
`- ${packageManagerPrefix} nx-cloud record -- echo Hello World`,
|
|
87
|
+
];
|
|
88
|
+
// Build nx command comments and command
|
|
89
|
+
const commandType = useRunMany ? 'run-many' : 'affected';
|
|
90
|
+
const nxCommandComments = useRunMany
|
|
91
|
+
? [
|
|
92
|
+
`As your workspace grows, you can change this to use Nx Affected to run only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
|
|
93
|
+
]
|
|
94
|
+
: [
|
|
95
|
+
`Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected`,
|
|
96
|
+
];
|
|
97
|
+
// Build command with conditional base arg
|
|
98
|
+
const baseArg = useRunMany ? '' : ' --base=HEAD~1';
|
|
99
|
+
const command = `${packageManagerPrefix} nx ${commandType} -t ${tasks}${baseArg}`;
|
|
100
|
+
return [
|
|
101
|
+
{
|
|
102
|
+
comments: nxCloudComments,
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
comments: nxCommandComments,
|
|
106
|
+
command,
|
|
107
|
+
},
|
|
108
|
+
];
|
|
109
|
+
}
|
|
9
110
|
async function ciWorkflowGenerator(tree, schema) {
|
|
10
111
|
const ci = schema.ci;
|
|
11
112
|
const options = normalizeOptions(schema, tree);
|
|
@@ -38,6 +139,11 @@ function normalizeOptions(options, tree) {
|
|
|
38
139
|
const hasE2E = hasCypress || hasPlaywright;
|
|
39
140
|
const hasTypecheck = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
|
|
40
141
|
const connectedToCloud = (0, nx_cloud_utils_1.isNxCloudUsed)((0, devkit_1.readJson)(tree, 'nx.json'));
|
|
142
|
+
const mainBranch = (0, default_base_1.deduceDefaultBase)();
|
|
143
|
+
const commands = getCiCommands(options.ci, packageManagerPrefix, mainBranch, hasTypecheck, hasE2E, options.useRunMany ?? false);
|
|
144
|
+
const branchCommands = options.ci === 'bitbucket-pipelines'
|
|
145
|
+
? getBitbucketBranchCommands(packageManagerPrefix, hasTypecheck, hasE2E, options.useRunMany ?? false)
|
|
146
|
+
: undefined;
|
|
41
147
|
return {
|
|
42
148
|
workflowName,
|
|
43
149
|
workflowFileName,
|
|
@@ -45,7 +151,7 @@ function normalizeOptions(options, tree) {
|
|
|
45
151
|
packageManagerInstall,
|
|
46
152
|
packageManagerPrefix,
|
|
47
153
|
packageManagerPreInstallPrefix,
|
|
48
|
-
mainBranch
|
|
154
|
+
mainBranch,
|
|
49
155
|
packageManagerVersion: packageJson?.packageManager?.split('@')[1],
|
|
50
156
|
hasCypress,
|
|
51
157
|
hasE2E,
|
|
@@ -54,6 +160,9 @@ function normalizeOptions(options, tree) {
|
|
|
54
160
|
nxCloudHost,
|
|
55
161
|
tmpl: '',
|
|
56
162
|
connectedToCloud,
|
|
163
|
+
useRunMany: options.useRunMany ?? false,
|
|
164
|
+
commands,
|
|
165
|
+
branchCommands,
|
|
57
166
|
};
|
|
58
167
|
}
|
|
59
168
|
function defaultBranchNeedsOriginPrefix(nxJson) {
|
|
@@ -8,13 +8,13 @@ pr:
|
|
|
8
8
|
variables:
|
|
9
9
|
CI: 'true'
|
|
10
10
|
${{ if eq(variables['Build.Reason'], 'PullRequest') }}:
|
|
11
|
-
NX_BRANCH: $(System.PullRequest.PullRequestNumber)
|
|
11
|
+
NX_BRANCH: $(System.PullRequest.PullRequestNumber)<% if(!useRunMany){ %>
|
|
12
12
|
TARGET_BRANCH: $[replace(variables['System.PullRequest.TargetBranch'],'refs/heads/','origin/')]
|
|
13
|
-
BASE_SHA: $(git merge-base $(TARGET_BRANCH) HEAD)
|
|
13
|
+
BASE_SHA: $(git merge-base $(TARGET_BRANCH) HEAD)<% } %>
|
|
14
14
|
${{ if ne(variables['Build.Reason'], 'PullRequest') }}:
|
|
15
|
-
NX_BRANCH: $(Build.SourceBranchName)
|
|
15
|
+
NX_BRANCH: $(Build.SourceBranchName)<% if(!useRunMany){ %>
|
|
16
16
|
BASE_SHA: $(git rev-parse HEAD~1)
|
|
17
|
-
HEAD_SHA: $(git rev-parse HEAD)
|
|
17
|
+
HEAD_SHA: $(git rev-parse HEAD)<% } %>
|
|
18
18
|
|
|
19
19
|
jobs:
|
|
20
20
|
- job: main
|
|
@@ -23,7 +23,7 @@ jobs:
|
|
|
23
23
|
steps:
|
|
24
24
|
- checkout: self
|
|
25
25
|
fetchDepth: 0
|
|
26
|
-
fetchFilter: tree:0
|
|
26
|
+
fetchFilter: tree:0<% if(!useRunMany){ %>
|
|
27
27
|
# Set Azure Devops CLI default settings
|
|
28
28
|
- bash: az devops configure --defaults organization=$(System.TeamFoundationCollectionUri) project=$(System.TeamProject)
|
|
29
29
|
displayName: 'Set default Azure DevOps organization and project'
|
|
@@ -40,7 +40,7 @@ jobs:
|
|
|
40
40
|
displayName: 'Get last successful commit SHA'
|
|
41
41
|
condition: ne(variables['Build.Reason'], 'PullRequest')
|
|
42
42
|
env:
|
|
43
|
-
AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)
|
|
43
|
+
AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)<% } %>
|
|
44
44
|
|
|
45
45
|
<% if(packageManager == 'pnpm'){ %>
|
|
46
46
|
- script: npm install --prefix=$HOME/.local -g pnpm@8
|
|
@@ -57,16 +57,15 @@ jobs:
|
|
|
57
57
|
# Run this command as early as possible, before dependencies are installed
|
|
58
58
|
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
|
59
59
|
<% if (connectedToCloud) { %># Uncomment this line to enable task distribution<% } else { %># Connect your workspace by running "nx connect" and uncomment this line to enable task distribution<% } %>
|
|
60
|
-
# - script: <%= packageManagerPreInstallPrefix %> nx
|
|
60
|
+
# - script: <%= packageManagerPreInstallPrefix %> nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="<% if(hasE2E){ %>e2e-ci<% } else { %>build<% } %>"
|
|
61
61
|
|
|
62
62
|
- script: <%= packageManagerInstall %><% if(hasCypress){ %>
|
|
63
63
|
- script: <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
|
|
64
|
-
- script: <%= packageManagerPrefix %> playwright install --with-deps<% } %>
|
|
64
|
+
- script: <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
|
|
65
65
|
- script: git branch --track <%= mainBranch %> origin/<%= mainBranch %>
|
|
66
|
-
condition: eq(variables['Build.Reason'], 'PullRequest')
|
|
66
|
+
condition: eq(variables['Build.Reason'], 'PullRequest')<% } %>
|
|
67
67
|
|
|
68
|
-
|
|
69
|
-
#
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
- script: <%= packageManagerPrefix %> nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e<% } %>
|
|
68
|
+
<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
|
|
69
|
+
# <%- comment %><% } %><% } %><% if (command.command) { %>
|
|
70
|
+
- script: <%= command.command %><% if (command.alwaysRun) { %>
|
|
71
|
+
condition: always()<% } %><% } %><% } %>
|
package/src/generators/ci-workflow/files/bitbucket-pipelines/bitbucket-pipelines.yml__tmpl__
CHANGED
|
@@ -23,17 +23,22 @@ pipelines:
|
|
|
23
23
|
# Run this command as early as possible, before dependencies are installed
|
|
24
24
|
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
|
25
25
|
<% if (connectedToCloud) { %># Uncomment this line to enable task distribution<% } else { %># Connect your workspace by running "nx connect" and uncomment this line to enable task distribution<% } %>
|
|
26
|
-
# - <%= packageManagerPreInstallPrefix %> nx
|
|
26
|
+
# - <%= packageManagerPreInstallPrefix %> nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="<% if(hasE2E){ %>e2e-ci<% } else { %>build<% } %>"
|
|
27
27
|
|
|
28
28
|
- <%= packageManagerInstall %><% if(hasCypress){ %>
|
|
29
29
|
- <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
|
|
30
30
|
- <%= packageManagerPrefix %> playwright install --with-deps<% } %>
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
#
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
32
|
+
<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
|
|
33
|
+
# <%- comment %><% } %><% } %><% if (command.command && !command.alwaysRun) { %>
|
|
34
|
+
- <%= command.command %><% } %><% } %>
|
|
35
|
+
<% const alwaysRunCommands = commands.filter(c => c.alwaysRun && c.command) %>
|
|
36
|
+
<% if (alwaysRunCommands.length > 0) { %>
|
|
37
|
+
after-script:
|
|
38
|
+
<% for (const command of alwaysRunCommands) { %>
|
|
39
|
+
- <%= command.command %>
|
|
40
|
+
<% } %>
|
|
41
|
+
<% } %>
|
|
37
42
|
|
|
38
43
|
branches:
|
|
39
44
|
main:
|
|
@@ -44,9 +49,9 @@ pipelines:
|
|
|
44
49
|
# This enables task distribution via Nx Cloud
|
|
45
50
|
# Run this command as early as possible, before dependencies are installed
|
|
46
51
|
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
|
47
|
-
<% if (connectedToCloud) { %>- <%= packageManagerPreInstallPrefix %> nx
|
|
52
|
+
<% if (connectedToCloud) { %>- <%= packageManagerPreInstallPrefix %> nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="<% if(hasE2E){ %>e2e-ci<% } else { %>build<% } %>"
|
|
48
53
|
<% } else { %># Connect your workspace by running "nx connect" and uncomment this
|
|
49
|
-
# - <%= packageManagerPreInstallPrefix %> nx
|
|
54
|
+
# - <%= packageManagerPreInstallPrefix %> nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="<% if(hasE2E){ %>e2e-ci<% } else { %>build<% } %>"
|
|
50
55
|
<% } %>
|
|
51
56
|
<% if(packageManager == 'pnpm'){ %>
|
|
52
57
|
- npm install --prefix=$HOME/.local -g pnpm@8
|
|
@@ -56,7 +61,13 @@ pipelines:
|
|
|
56
61
|
<% } %>
|
|
57
62
|
- <%= packageManagerInstall %>
|
|
58
63
|
|
|
59
|
-
|
|
60
|
-
#
|
|
61
|
-
|
|
62
|
-
|
|
64
|
+
<% for (const command of branchCommands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
|
|
65
|
+
# <%- comment %><% } %><% } %><% if (command.command && !command.alwaysRun) { %>
|
|
66
|
+
- <%= command.command %><% } %><% } %>
|
|
67
|
+
<% const alwaysRunBranchCommands = branchCommands.filter(c => c.alwaysRun && c.command) %>
|
|
68
|
+
<% if (alwaysRunBranchCommands.length > 0) { %>
|
|
69
|
+
after-script:
|
|
70
|
+
<% for (const command of alwaysRunBranchCommands) { %>
|
|
71
|
+
- <%= command.command %>
|
|
72
|
+
<% } %>
|
|
73
|
+
<% } %>
|
|
@@ -25,19 +25,19 @@ jobs:
|
|
|
25
25
|
# Run this command as early as possible, before dependencies are installed
|
|
26
26
|
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
|
27
27
|
<% if (connectedToCloud) { %># Uncomment this line to enable task distribution<% } else { %># Connect your workspace by running "nx connect" and uncomment this line to enable task distribution<% } %>
|
|
28
|
-
# - run: <%= packageManagerPreInstallPrefix %> nx
|
|
28
|
+
# - run: <%= packageManagerPreInstallPrefix %> nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="<% if(hasE2E){ %>e2e-ci<% } else { %>build<% } %>"
|
|
29
29
|
|
|
30
30
|
- run: <%= packageManagerInstall %><% if(hasCypress){ %>
|
|
31
31
|
- run: <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
|
|
32
|
-
- run: <%= packageManagerPrefix %> playwright install --with-deps<% } %>
|
|
32
|
+
- run: <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
|
|
33
33
|
- nx/set-shas:
|
|
34
|
-
main-branch-name: '<%= mainBranch %>'
|
|
34
|
+
main-branch-name: '<%= mainBranch %>'<% } %>
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
#
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
36
|
+
<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
|
|
37
|
+
# <%- comment %><% } %><% } %><% if (command.command) { %>
|
|
38
|
+
- run:
|
|
39
|
+
command: <%= command.command %><% if (command.alwaysRun) { %>
|
|
40
|
+
when: always<% } %><% } %><% } %>
|
|
41
41
|
|
|
42
42
|
workflows:
|
|
43
43
|
version: 2
|
package/src/generators/ci-workflow/files/github/.github/workflows/__workflowFileName__.yml__tmpl__
CHANGED
|
@@ -36,7 +36,7 @@ jobs:
|
|
|
36
36
|
# Run this command as early as possible, before dependencies are installed
|
|
37
37
|
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
|
38
38
|
<% if (connectedToCloud) { %># Uncomment this line to enable task distribution<% } else { %># Connect your workspace by running "nx connect" and uncomment this line to enable task distribution<% } %>
|
|
39
|
-
# - run: <%= packageManagerPreInstallPrefix %> nx
|
|
39
|
+
# - run: <%= packageManagerPreInstallPrefix %> nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="<% if(hasE2E){ %>e2e-ci<% } else { %>build<% } %>"
|
|
40
40
|
|
|
41
41
|
<% if(packageManager !== 'bun'){ %>
|
|
42
42
|
# Cache node_modules
|
|
@@ -47,11 +47,10 @@ jobs:
|
|
|
47
47
|
<% } %>
|
|
48
48
|
- run: <%= packageManagerInstall %><% if(hasCypress){ %>
|
|
49
49
|
- run: <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
|
|
50
|
-
- run: <%= packageManagerPrefix %> playwright install --with-deps<% } %>
|
|
51
|
-
- uses: nrwl/nx-set-shas@v4
|
|
50
|
+
- run: <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
|
|
51
|
+
- uses: nrwl/nx-set-shas@v4<% } %>
|
|
52
52
|
|
|
53
|
-
|
|
54
|
-
#
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
- run: <%= packageManagerPrefix %> nx affected -t lint test build<% if(hasTypecheck){ %> typecheck<% } %><% if(hasE2E){ %> e2e<% } %>
|
|
53
|
+
<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
|
|
54
|
+
# <%- comment %><% } %><% } %><% if (command.command) { %>
|
|
55
|
+
- run: <%= command.command %><% if (command.alwaysRun) { %>
|
|
56
|
+
if: always()<% } %><% } %><% } %>
|
|
@@ -19,16 +19,21 @@ variables:
|
|
|
19
19
|
# Run this command as early as possible, before dependencies are installed
|
|
20
20
|
# Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
|
|
21
21
|
<% if (connectedToCloud) { %># Uncomment this line to enable task distribution<% } else { %># Connect your workspace by running "nx connect" and uncomment this line to enable task distribution<% } %>
|
|
22
|
-
# - <%= packageManagerPreInstallPrefix %> nx
|
|
22
|
+
# - <%= packageManagerPreInstallPrefix %> nx start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="<% if(hasE2E){ %>e2e-ci<% } else { %>build<% } %>"
|
|
23
23
|
|
|
24
24
|
- <%= packageManagerInstall %><% if(hasCypress){ %>
|
|
25
25
|
- <%= packageManagerPrefix %> cypress install<% } %><% if(hasPlaywright){ %>
|
|
26
|
-
- <%= packageManagerPrefix %> playwright install --with-deps<% } %>
|
|
26
|
+
- <%= packageManagerPrefix %> playwright install --with-deps<% } %><% if(!useRunMany){ %>
|
|
27
27
|
- NX_HEAD=$CI_COMMIT_SHA
|
|
28
|
-
- NX_BASE=${CI_MERGE_REQUEST_DIFF_BASE_SHA:-$CI_COMMIT_BEFORE_SHA}
|
|
28
|
+
- NX_BASE=${CI_MERGE_REQUEST_DIFF_BASE_SHA:-$CI_COMMIT_BEFORE_SHA}<% } %>
|
|
29
29
|
|
|
30
|
-
|
|
31
|
-
#
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
30
|
+
<% for (const command of commands) { %><% if (command.comments) { %><% for (const comment of command.comments) { %>
|
|
31
|
+
# <%- comment %><% } %><% } %><% if (command.command && !command.alwaysRun) { %>
|
|
32
|
+
- <%= command.command %><% } %><% } %>
|
|
33
|
+
<% const alwaysRunCommands = commands.filter(c => c.alwaysRun && c.command) %>
|
|
34
|
+
<% if (alwaysRunCommands.length > 0) { %>
|
|
35
|
+
after_script:
|
|
36
|
+
<% for (const command of alwaysRunCommands) { %>
|
|
37
|
+
- <%= command.command %>
|
|
38
|
+
<% } %>
|
|
39
|
+
<% } %>
|
|
@@ -32,6 +32,12 @@
|
|
|
32
32
|
"default": "CI",
|
|
33
33
|
"x-prompt": "How should we name your workflow?",
|
|
34
34
|
"pattern": "^[a-zA-Z].*$"
|
|
35
|
+
},
|
|
36
|
+
"useRunMany": {
|
|
37
|
+
"type": "boolean",
|
|
38
|
+
"description": "Use 'nx run-many' instead of 'nx affected' in the generated CI workflow.",
|
|
39
|
+
"default": false,
|
|
40
|
+
"hidden": true
|
|
35
41
|
}
|
|
36
42
|
},
|
|
37
43
|
"required": ["ci", "name"]
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.createProjectConfigurationInNewDestination = createProjectConfigurationInNewDestination;
|
|
4
4
|
const devkit_1 = require("@nx/devkit");
|
|
5
|
+
const project_config_1 = require("../../utils/project-config");
|
|
5
6
|
function createProjectConfigurationInNewDestination(tree, schema, projectConfig) {
|
|
6
7
|
projectConfig.name = schema.newProjectName;
|
|
7
8
|
const isRootProject = projectConfig.root === '.';
|
|
@@ -45,8 +46,9 @@ function createProjectConfigurationInNewDestination(tree, schema, projectConfig)
|
|
|
45
46
|
}
|
|
46
47
|
// Original sourceRoot is typically 'src' or 'app', but it could be any folder.
|
|
47
48
|
// Make sure it is updated to be under the new destination.
|
|
48
|
-
|
|
49
|
-
|
|
49
|
+
const sourceRoot = (0, project_config_1.getProjectSourceRoot)(projectConfig, tree);
|
|
50
|
+
if (isRootProject && sourceRoot) {
|
|
51
|
+
newProject.sourceRoot = (0, devkit_1.joinPathFragments)(schema.relativeToRootDestination, sourceRoot);
|
|
50
52
|
}
|
|
51
53
|
if (schema.isNxConfiguredInPackageJson) {
|
|
52
54
|
// Update the existing project configuration in the package.json
|
|
@@ -8,6 +8,7 @@ const ts_config_1 = require("../../../utilities/ts-config");
|
|
|
8
8
|
const typescript_1 = require("../../../utilities/typescript");
|
|
9
9
|
const utils_1 = require("./utils");
|
|
10
10
|
const ts_solution_setup_1 = require("../../../utilities/typescript/ts-solution-setup");
|
|
11
|
+
const project_config_1 = require("../../utils/project-config");
|
|
11
12
|
let tsModule;
|
|
12
13
|
/**
|
|
13
14
|
* Updates all the imports in the workspace and modifies the tsconfig appropriately.
|
|
@@ -33,7 +34,7 @@ function updateImports(tree, schema, project) {
|
|
|
33
34
|
let serverEntryPointImportPath;
|
|
34
35
|
if (tree.exists(tsConfigPath)) {
|
|
35
36
|
tsConfig = (0, devkit_1.readJson)(tree, tsConfigPath);
|
|
36
|
-
const sourceRoot =
|
|
37
|
+
const sourceRoot = (0, project_config_1.getProjectSourceRoot)(project, tree);
|
|
37
38
|
mainEntryPointImportPath = Object.keys(tsConfig.compilerOptions?.paths ?? {}).find((path) => tsConfig.compilerOptions.paths[path].some((x) => x.startsWith(ensureTrailingSlash(sourceRoot))));
|
|
38
39
|
secondaryEntryPointImportPaths = Object.keys(tsConfig.compilerOptions?.paths ?? {}).filter((path) => tsConfig.compilerOptions.paths[path].some((x) => x.startsWith(ensureTrailingSlash(project.root)) &&
|
|
39
40
|
!x.startsWith(ensureTrailingSlash(sourceRoot))));
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Tree } from '@nx/devkit';
|
|
2
2
|
import { Linter, LinterType } from '../../utils/lint';
|
|
3
3
|
interface Schema {
|
|
4
4
|
directory: string;
|
|
@@ -14,18 +14,18 @@ interface Schema {
|
|
|
14
14
|
nextAppDir?: boolean;
|
|
15
15
|
nextSrcDir?: boolean;
|
|
16
16
|
linter?: Linter | LinterType;
|
|
17
|
-
bundler?:
|
|
17
|
+
bundler?: string;
|
|
18
18
|
standaloneApi?: boolean;
|
|
19
19
|
routing?: boolean;
|
|
20
20
|
useReactRouter?: boolean;
|
|
21
|
-
packageManager?:
|
|
22
|
-
unitTestRunner?:
|
|
23
|
-
e2eTestRunner?:
|
|
21
|
+
packageManager?: string;
|
|
22
|
+
unitTestRunner?: string;
|
|
23
|
+
e2eTestRunner?: string;
|
|
24
24
|
ssr?: boolean;
|
|
25
25
|
prefix?: string;
|
|
26
26
|
useGitHub?: boolean;
|
|
27
27
|
nxCloud?: 'yes' | 'skip' | 'circleci' | 'github';
|
|
28
|
-
formatter?:
|
|
28
|
+
formatter?: string;
|
|
29
29
|
workspaces?: boolean;
|
|
30
30
|
workspaceGlobs?: string | string[];
|
|
31
31
|
useProjectJson?: boolean;
|
|
@@ -55,18 +55,15 @@
|
|
|
55
55
|
"linter": {
|
|
56
56
|
"description": "The tool to use for running lint checks.",
|
|
57
57
|
"type": "string",
|
|
58
|
-
"enum": ["eslint", "none"],
|
|
59
58
|
"default": "eslint"
|
|
60
59
|
},
|
|
61
60
|
"packageManager": {
|
|
62
61
|
"description": "The package manager used to install dependencies.",
|
|
63
|
-
"type": "string"
|
|
64
|
-
"enum": ["npm", "yarn", "pnpm", "bun"]
|
|
62
|
+
"type": "string"
|
|
65
63
|
},
|
|
66
64
|
"framework": {
|
|
67
65
|
"description": "The framework which the application is using",
|
|
68
|
-
"type": "string"
|
|
69
|
-
"enum": ["express", "koa", "fastify", "nest", "none"]
|
|
66
|
+
"type": "string"
|
|
70
67
|
},
|
|
71
68
|
"nextAppDir": {
|
|
72
69
|
"description": "Enable the App Router for this project.",
|
|
@@ -80,13 +77,11 @@
|
|
|
80
77
|
},
|
|
81
78
|
"unitTestRunner": {
|
|
82
79
|
"description": "The tool to use for running unit tests.",
|
|
83
|
-
"type": "string"
|
|
84
|
-
"enum": ["jest", "vitest", "none"]
|
|
80
|
+
"type": "string"
|
|
85
81
|
},
|
|
86
82
|
"e2eTestRunner": {
|
|
87
83
|
"description": "The tool to use for running e2e tests.",
|
|
88
|
-
"type": "string"
|
|
89
|
-
"enum": ["playwright", "cypress", "jest", "detox", "none"]
|
|
84
|
+
"type": "string"
|
|
90
85
|
},
|
|
91
86
|
"ssr": {
|
|
92
87
|
"description": "Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application.",
|
|
@@ -100,7 +95,6 @@
|
|
|
100
95
|
"formatter": {
|
|
101
96
|
"description": "The tool to use for code formatting.",
|
|
102
97
|
"type": "string",
|
|
103
|
-
"enum": ["none", "prettier"],
|
|
104
98
|
"default": "none"
|
|
105
99
|
},
|
|
106
100
|
"workspaces": {
|
|
@@ -6,20 +6,20 @@ export interface Schema {
|
|
|
6
6
|
preset: Preset;
|
|
7
7
|
style?: string;
|
|
8
8
|
linter?: string;
|
|
9
|
-
formatter?:
|
|
9
|
+
formatter?: string;
|
|
10
10
|
workspaces?: boolean;
|
|
11
11
|
standaloneConfig?: boolean;
|
|
12
12
|
framework?: string;
|
|
13
|
-
packageManager?:
|
|
14
|
-
bundler?:
|
|
13
|
+
packageManager?: string;
|
|
14
|
+
bundler?: string;
|
|
15
15
|
docker?: boolean;
|
|
16
16
|
nextAppDir?: boolean;
|
|
17
17
|
nextSrcDir?: boolean;
|
|
18
18
|
routing?: boolean;
|
|
19
19
|
useReactRouter?: boolean;
|
|
20
20
|
standaloneApi?: boolean;
|
|
21
|
-
unitTestRunner?:
|
|
22
|
-
e2eTestRunner?:
|
|
21
|
+
unitTestRunner?: string;
|
|
22
|
+
e2eTestRunner?: string;
|
|
23
23
|
js?: boolean;
|
|
24
24
|
ssr?: boolean;
|
|
25
25
|
serverRouting?: boolean;
|
|
@@ -17,7 +17,6 @@
|
|
|
17
17
|
"linter": {
|
|
18
18
|
"description": "The tool to use for running lint checks.",
|
|
19
19
|
"type": "string",
|
|
20
|
-
"enum": ["eslint", "none"],
|
|
21
20
|
"default": "eslint"
|
|
22
21
|
},
|
|
23
22
|
"routing": {
|
|
@@ -66,18 +65,15 @@
|
|
|
66
65
|
},
|
|
67
66
|
"packageManager": {
|
|
68
67
|
"description": "The package manager used to install dependencies.",
|
|
69
|
-
"type": "string"
|
|
70
|
-
"enum": ["npm", "yarn", "pnpm", "bun"]
|
|
68
|
+
"type": "string"
|
|
71
69
|
},
|
|
72
70
|
"framework": {
|
|
73
71
|
"description": "The framework which the application is using",
|
|
74
|
-
"type": "string"
|
|
75
|
-
"enum": ["express", "koa", "fastify", "nest", "none"]
|
|
72
|
+
"type": "string"
|
|
76
73
|
},
|
|
77
74
|
"bundler": {
|
|
78
75
|
"description": "The bundler to use for building the application.",
|
|
79
76
|
"type": "string",
|
|
80
|
-
"enum": ["vite", "rspack", "rsbuild", "esbuild", "webpack"],
|
|
81
77
|
"default": "vite"
|
|
82
78
|
},
|
|
83
79
|
"docker": {
|
|
@@ -97,13 +93,11 @@
|
|
|
97
93
|
},
|
|
98
94
|
"unitTestRunner": {
|
|
99
95
|
"description": "The tool to use for running unit tests.",
|
|
100
|
-
"type": "string"
|
|
101
|
-
"enum": ["jest", "vitest", "none"]
|
|
96
|
+
"type": "string"
|
|
102
97
|
},
|
|
103
98
|
"e2eTestRunner": {
|
|
104
99
|
"description": "The tool to use for running e2e tests.",
|
|
105
|
-
"type": "string"
|
|
106
|
-
"enum": ["playwright", "cypress", "jest", "detox", "none"]
|
|
100
|
+
"type": "string"
|
|
107
101
|
},
|
|
108
102
|
"ssr": {
|
|
109
103
|
"description": "Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application.",
|
|
@@ -117,7 +111,6 @@
|
|
|
117
111
|
"formatter": {
|
|
118
112
|
"description": "The tool to use for code formatting.",
|
|
119
113
|
"type": "string",
|
|
120
|
-
"enum": ["none", "prettier"],
|
|
121
114
|
"default": "none"
|
|
122
115
|
},
|
|
123
116
|
"workspaces": {
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getProjectSourceRoot = getProjectSourceRoot;
|
|
4
|
+
const devkit_1 = require("@nx/devkit");
|
|
5
|
+
const node_fs_1 = require("node:fs");
|
|
6
|
+
const node_path_1 = require("node:path");
|
|
7
|
+
function getProjectSourceRoot(project, tree) {
|
|
8
|
+
if (tree) {
|
|
9
|
+
return (project.sourceRoot ??
|
|
10
|
+
(tree.exists((0, devkit_1.joinPathFragments)(project.root, 'src'))
|
|
11
|
+
? (0, devkit_1.joinPathFragments)(project.root, 'src')
|
|
12
|
+
: project.root));
|
|
13
|
+
}
|
|
14
|
+
return (project.sourceRoot ??
|
|
15
|
+
((0, node_fs_1.existsSync)((0, node_path_1.join)(devkit_1.workspaceRoot, project.root, 'src'))
|
|
16
|
+
? (0, devkit_1.joinPathFragments)(project.root, 'src')
|
|
17
|
+
: project.root));
|
|
18
|
+
}
|