Skip to content

Commit 121ba4e

Browse files
committed
docs: adjust config example
1 parent 4373c4c commit 121ba4e

File tree

2 files changed

+18
-28
lines changed

2 files changed

+18
-28
lines changed

packages/cli/docs/nx-caching.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -56,29 +56,20 @@ export default {
5656
"options": {
5757
"command": "npx @code-pushup/cli collect",
5858
"config": "{projectRoot}/code-pushup.config.ts",
59-
"cache.write": true,
60-
"persist.skipReports": true,
61-
"persist.outputDir": "{projectRoot}/.code-pushup",
62-
"upload.project": "{projectName}",
59+
"cache": {
60+
"write": true
61+
},
62+
"persist": {
63+
"skipReports": true,
64+
"outputDir": "{projectRoot}/.code-pushup"
65+
},
66+
"upload": {
67+
"project": "{projectName}"
68+
},
6369
"outputPath": "{projectRoot}/.code-pushup/coverage"
6470
},
6571
"dependsOn": ["unit-test", "int-test"]
6672
},
67-
"code-pushup-js-packages": {
68-
"cache": true,
69-
"outputs": ["{options.outputPath}"],
70-
"executor": "nx:run-commands",
71-
"options": {
72-
"command": "npx @code-pushup/cli collect",
73-
"config": "{projectRoot}/code-pushup.config.ts",
74-
"cache.write": true,
75-
"persist.skipReports": true,
76-
"persist.outputDir": "{projectRoot}/.code-pushup",
77-
"upload.project": "{projectName}",
78-
"onlyPlugins": "js-packages",
79-
"outputPath": "{projectRoot}/.code-pushup/js-packages"
80-
}
81-
},
8273
"code-pushup": {
8374
"cache": true,
8475
"outputs": ["{options.outputPath}"],
@@ -90,7 +81,7 @@ export default {
9081
"upload.project": "{projectName}",
9182
"outputPath": "{projectRoot}/.code-pushup"
9283
},
93-
"dependsOn": ["code-pushup:coverage", "code-pushup:js-packages"]
84+
"dependsOn": ["code-pushup:coverage"]
9485
}
9586
}
9687
}
@@ -106,19 +97,18 @@ This configuration creates the following task dependency graph:
10697

10798
```mermaid
10899
graph TD
109-
A[lib-a:code-pushup 🐳] --> B[lib-a:code-pushup:coverage 🐳]
110-
A --> E[lib-a:code-pushup:js-packages]
100+
A[lib-a:code-pushup 🐳] --> B[lib-a:code-pushup-coverage 🐳]
111101
B --> C[lib-a:unit-test 🐳]
112102
B --> D[lib-a:int-test 🐳]
113103
```
114104

115105
## Command Line Example
116106

117107
```bash
118-
# Run all affected project plugins and cache the output if configured
119-
nx affected --target=code-pushup-coverage,code-pushup-jspackages
108+
# Run all affected project plugins `coverage` and cache the output if configured
109+
nx affected --target=code-pushup-coverage
120110

121-
# Run all affected projects and upload the report to the portal
111+
# Run all affected projects with plugins `coverage` and `js-packages` and upload the report to the portal
122112
nx affected --target=code-pushup
123113
```
124114

packages/cli/docs/turbo-caching.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ graph TD
8989
## Command Line Examples
9090

9191
```bash
92-
# Run all affected project plugins and cache the output if configured
93-
turbo run code-pushup-coverage code-pushup-jspackages --filter=[origin/main]
92+
# Run all affected project plugins `coverage` and cache the output if configured
93+
turbo run code-pushup-coverage --filter=[origin/main]
9494

95-
# Run all affected projects and upload the report to the portal
95+
# Run all affected projects with plugins `coverage` and `js-packages` and upload the report to the portal
9696
turbo run code-pushup --filter=[origin/main]
9797
```
9898

0 commit comments

Comments
 (0)