Skip to content

Commit 0b9d679

Browse files
committed
feat(ci): remove obsolete output option
1 parent ad8bd28 commit 0b9d679

File tree

4 files changed

+2
-10
lines changed

4 files changed

+2
-10
lines changed

packages/ci/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,20 +99,17 @@ Optionally, you can override default options for further customization:
9999
| `monorepo` | `boolean \| MonorepoTool` | `false` | Enables [monorepo mode](#monorepo-mode) |
100100
| `projects` | `string[] \| null` | `null` | Custom projects configuration for [monorepo mode](#monorepo-mode) |
101101
| `task` | `string` | `'code-pushup'` | Name of command to run Code PushUp per project in [monorepo mode](#monorepo-mode) |
102-
| `nxProjectsFilter` | `string \| string[]` | `'--with-target={task}'` | Arguments passed to [`nx show projects`](https://nx.dev/nx-api/nx/documents/show#projects), only relevant for Nx in [monorepo mode](#monorepo-mode) [^3] |
102+
| `nxProjectsFilter` | `string \| string[]` | `'--with-target={task}'` | Arguments passed to [`nx show projects`](https://nx.dev/nx-api/nx/documents/show#projects), only relevant for Nx in [monorepo mode](#monorepo-mode) [^2] |
103103
| `directory` | `string` | `process.cwd()` | Directory in which Code PushUp CLI should run |
104104
| `config` | `string \| null` | `null` [^1] | Path to config file (`--config` option) |
105105
| `silent` | `boolean` | `false` | Toggles if logs from CLI commands are printed |
106106
| `bin` | `string` | `'npx --no-install code-pushup'` | Command for executing Code PushUp CLI |
107107
| `detectNewIssues` | `boolean` | `true` | Toggles if new issues should be detected and returned in `newIssues` property |
108108
| `logger` | `Logger` | `console` | Logger for reporting progress and encountered problems |
109-
| `output` | `string` | `'.code-pushup'` | Directory where Code PushUp reports will be created (interpolates project name [^2]) |
110109

111110
[^1]: By default, the `code-pushup.config` file is autodetected as described in [`@code-pushup/cli` docs](../cli/README.md#configuration).
112111

113-
[^2]: In monorepo mode, any occurrence of `{project}` in the `output` path will be replaced with a project name. This separation of folders per project (e.g. `output: '.code-pushup/{project}'`) may be useful for caching purposes.
114-
115-
[^3]: The `{task}` pattern is replaced with the `task` value, so the default behaviour is to list projects using `npx nx show projects --with-target=code-pushup --json`. The `nxProjectsFilter` options gives Nx users the flexibility to filter projects in alternative ways supported by the Nx CLI (e.g. `--affected`, `--projects`, `--exclude`, `--type`) - refer to [options in Nx docs](https://nx.dev/nx-api/nx/documents/show#options) for details.
112+
[^2]: The `{task}` pattern is replaced with the `task` value, so the default behaviour is to list projects using `npx nx show projects --with-target=code-pushup --json`. The `nxProjectsFilter` options gives Nx users the flexibility to filter projects in alternative ways supported by the Nx CLI (e.g. `--affected`, `--projects`, `--exclude`, `--type`) - refer to [options in Nx docs](https://nx.dev/nx-api/nx/documents/show#options) for details.
116113

117114
The `Logger` object has the following required properties:
118115

packages/ci/src/lib/cli/context.unit.test.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ describe('createCommandContext', () => {
1313
logger: console,
1414
monorepo: false,
1515
nxProjectsFilter: '--with-target={task}',
16-
output: '.code-pushup',
1716
projects: null,
1817
silent: false,
1918
task: 'code-pushup',
@@ -40,7 +39,6 @@ describe('createCommandContext', () => {
4039
logger: console,
4140
monorepo: false,
4241
nxProjectsFilter: '--with-target={task}',
43-
output: '.code-pushup',
4442
projects: null,
4543
silent: false,
4644
task: 'code-pushup',

packages/ci/src/lib/constants.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { DEFAULT_PERSIST_OUTPUT_DIR } from '@code-pushup/models';
21
import type { Settings } from './models.js';
32

43
export const DEFAULT_SETTINGS: Settings = {
@@ -12,6 +11,5 @@ export const DEFAULT_SETTINGS: Settings = {
1211
debug: false,
1312
detectNewIssues: true,
1413
logger: console,
15-
output: DEFAULT_PERSIST_OUTPUT_DIR,
1614
nxProjectsFilter: '--with-target={task}',
1715
};

packages/ci/src/lib/models.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ export type Options = {
1818
debug?: boolean;
1919
detectNewIssues?: boolean;
2020
logger?: Logger;
21-
output?: string;
2221
};
2322

2423
/**

0 commit comments

Comments
 (0)