@code-pushup/cli 0.35.0 → 0.42.0
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/README.md
CHANGED
|
@@ -168,9 +168,9 @@ Each example is fully tested to demonstrate best practices for plugin testing as
|
|
|
168
168
|
|
|
169
169
|
**Example for custom plugins:**
|
|
170
170
|
|
|
171
|
-
- 📏 [File Size](../../examples/plugins/src/file-size)
|
|
172
|
-
- 📦 [Package Json](../../examples/plugins/src/package-json)
|
|
173
|
-
- 🔥 [Lighthouse](../../examples/plugins/src/lighthouse) (official implementation [here](../../../../packages/plugin-lighthouse))
|
|
171
|
+
- 📏 [File Size](../../examples/plugins/src/file-size) - example of basic runner executor
|
|
172
|
+
- 📦 [Package Json](../../examples/plugins/src/package-json) - example of audits and groups
|
|
173
|
+
- 🔥 [Lighthouse](../../examples/plugins/src/lighthouse) (official implementation [here](../../../../packages/plugin-lighthouse)) - example of a basic command executor
|
|
174
174
|
|
|
175
175
|
## CLI commands and options
|
|
176
176
|
|
|
@@ -240,6 +240,25 @@ Run plugins, collect results and upload the report to the Code PushUp portal.
|
|
|
240
240
|
|
|
241
241
|
Refer to the [Common Command Options](#common-command-options) for the list of available options.
|
|
242
242
|
|
|
243
|
+
#### `history` command
|
|
244
|
+
|
|
245
|
+
Usage:
|
|
246
|
+
`code-pushup history`
|
|
247
|
+
|
|
248
|
+
Description:
|
|
249
|
+
Run plugins, collect results and upload the report to the Code PushUp portal for a specified number of commits.
|
|
250
|
+
|
|
251
|
+
Refer to the [Common Command Options](#common-command-options) for the list of available options.
|
|
252
|
+
|
|
253
|
+
| Option | Type | Default | Description |
|
|
254
|
+
| ------------------------ | --------- | ------- | ---------------------------------------------------------------- |
|
|
255
|
+
| **`--targetBranch`** | `string` | 'main' | Branch to crawl history. |
|
|
256
|
+
| **`--forceCleanStatus`** | `boolean` | `false` | If we reset the status to a clean git history forcefully or not. |
|
|
257
|
+
| **`--maxCount`** | `number` | 5 | Number of commits. |
|
|
258
|
+
| **`--skipUploads`** | `boolean` | `false` | Upload created reports |
|
|
259
|
+
| **`--from`** | `string` | n/a | Hash to start in history |
|
|
260
|
+
| **`--to`** | `string` | n/a | Hash to end in history |
|
|
261
|
+
|
|
243
262
|
### `compare` command
|
|
244
263
|
|
|
245
264
|
Usage:
|