paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

remove some cli deprecation warnings

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@spotify.com>
This commit is contained in:
Fredrik Adelöw
2026-03-30 09:41:58 +02:00
parent 0336f92de8
commit 6cc48113fc
8 changed files with 30 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/funny-items-wink.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli-module-test-jest': patch
---
Minor error message update
.github/workflows/ci.yml
+2 -2
View File
@@ -268,10 +268,10 @@ jobs:
run: yarn prettier:check --cache --cache-location .cache/backstage-cli/.prettier-cache
- name: lint changed packages
run: yarn backstage-cli repo lint --since origin/master --successCache --successCacheDir .cache/backstage-cli
run: yarn backstage-cli repo lint --since origin/master --success-cache --success-cache-dir .cache/backstage-cli
- name: test changed packages
run: yarn backstage-cli repo test --maxWorkers=3 --workerIdleMemoryLimit=1300M --since origin/master --successCache --successCacheDir .cache/backstage-cli
run: yarn backstage-cli repo test --maxWorkers=3 --workerIdleMemoryLimit=1300M --since origin/master --success-cache --success-cache-dir .cache/backstage-cli
env:
BACKSTAGE_TEST_DISABLE_DOCKER: 1
BACKSTAGE_TEST_DATABASE_POSTGRES18_CONNECTION_STRING: postgresql://postgres:postgres@localhost:${{ job.services.postgres18.ports[5432] }}
.github/workflows/deploy_packages.yml
+2 -2
View File
@@ -102,7 +102,7 @@ jobs:
${{ runner.os }}-v${{ matrix.node-version }}-backstage-cli-
- name: lint
run: yarn backstage-cli repo lint --successCache --successCacheDir .cache/backstage-cli
run: yarn backstage-cli repo lint --success-cache --success-cache-dir .cache/backstage-cli
- name: type checking and declarations
run: yarn tsc:full
@@ -115,7 +115,7 @@ jobs:
- name: test (and upload coverage)
run: |
yarn backstage-cli repo test --maxWorkers=3 --workerIdleMemoryLimit=1300M --coverage --successCache --successCacheDir .cache/backstage-cli
yarn backstage-cli repo test --maxWorkers=3 --workerIdleMemoryLimit=1300M --coverage --success-cache --success-cache-dir .cache/backstage-cli
env:
BACKSTAGE_TEST_DISABLE_DOCKER: 1
BACKSTAGE_TEST_DATABASE_postgres18_CONNECTION_STRING: postgresql://postgres:postgres@localhost:${{ job.services.postgres18.ports[5432] }}
.github/workflows/verify_windows.yml
+2 -2
View File
@@ -46,7 +46,7 @@ jobs:
run: yarn install --immutable
- name: lint
run: yarn backstage-cli repo lint --successCache
run: yarn backstage-cli repo lint --success-cache
- name: type checking and declarations
run: yarn tsc:full
@@ -55,7 +55,7 @@ jobs:
run: yarn lint:type-deps
- name: test
run: yarn backstage-cli repo test --maxWorkers=3 --workerIdleMemoryLimit=1300M --successCache
run: yarn backstage-cli repo test --maxWorkers=3 --workerIdleMemoryLimit=1300M --success-cache
env:
BACKSTAGE_TEST_DISABLE_DOCKER: 1
docs/tooling/cli/02-build-system.md
+3 -3
View File
@@ -609,8 +609,8 @@ If set to `true`, any attempt to make a network request in frontend package test
Caching is used sparingly throughout the Backstage build system. It is always used as a way to squeeze out a little bit of extra performance, rather than requirement to keep things fast. The following is a list of places where optional caching is available:
- **TypeScript** - The default `tsconfig.json` used by Backstage projects has `incremental` set to `true`, which enables local caching of type checking results. It is however generally not recommended in CI, where `yarn tsc:full` is preferred, which sets `--incremental false`.
- **Testing** - The `backstage-cli repo test` command has a `--successCache` flag that enables caching of successful test results. This is done at the package level, meaning that if a package has not been changed since the last test run and it was successful, the testing will be skipped. This is recommended to be used in CI, but not during local development.
- **Linting** - The `backstage-cli repo lint` command has a `--successCache` flag that enables caching of successful linting results. This is done at the package level, meaning that if a package has not been changed since the last lint run and it was successful, the linting will be skipped. This is recommended to be used in CI, but not during local development.
- **Testing** - The `backstage-cli repo test` command has a `--success-cache` flag that enables caching of successful test results. This is done at the package level, meaning that if a package has not been changed since the last test run and it was successful, the testing will be skipped. This is recommended to be used in CI, but not during local development.
- **Linting** - The `backstage-cli repo lint` command has a `--success-cache` flag that enables caching of successful linting results. This is done at the package level, meaning that if a package has not been changed since the last lint run and it was successful, the linting will be skipped. This is recommended to be used in CI, but not during local development.
- **Webpack** - It is possible to enable experimental caching of frontend package builds using the `BACKSTAGE_CLI_EXPERIMENTAL_BUILD_CACHE` environment variable. This will enable the Webpack filesystem cache.
### Debugging Jest Tests
@@ -654,7 +654,7 @@ With that in mind, here are some IDEs configurations to run backstage components
}
```
3. Add a launch configuration for VS Code in `launch.json` in the `.vscode` folder.
3. Add a launch configuration for VS Code in `launch.json` in the `.vscode` folder.
A complete configuration for debugging may look like this:
```jsonc
docs/tooling/cli/03-commands.md
+12 -12
View File
@@ -120,11 +120,11 @@ Usage: backstage-cli repo lint [options]
Lint all packages in the project
Options:
--format <format> Lint report output format (default: "eslint-formatter-friendly")
--since <ref> Only lint packages that changed since the specified ref
--successCache Enable success caching, which skips running tests for unchanged packages that were successful in the previous run
--successCacheDir <path> Set the success cache location, (default: node_modules/.cache/backstage-cli)
--fix Attempt to automatically fix violations
--format <format> Lint report output format (default: "eslint-formatter-friendly")
--since <ref> Only lint packages that changed since the specified ref
--success-cache Enable success caching, which skips running tests for unchanged packages that were successful in the previous run
--success-cache-dir <path> Set the success cache location, (default: node_modules/.cache/backstage-cli)
--fix Attempt to automatically fix violations
```
## repo test
@@ -153,7 +153,7 @@ If arguments are provided, they will be forwarded to Jest and used to filter tes
yarn test packages/app/src/App.test.tsx
```
If you want to avoid re-running tests that have not changed since the last successful run in CI, you can use the `--successCache` flag. By default this cache is stored in `node_modules/.cache/backstage-cli`, but you can choose a different directory with the `--successCacheDir <path>`.
If you want to avoid re-running tests that have not changed since the last successful run in CI, you can use the `--success-cache` flag. By default this cache is stored in `node_modules/.cache/backstage-cli`, but you can choose a different directory with the `--success-cache-dir <path>`.
```text
Usage: backstage-cli repo test [options]
@@ -161,11 +161,11 @@ Usage: backstage-cli repo test [options]
Run tests, forwarding args to Jest, defaulting to watch mode
Options:
--since <ref> Only test packages that changed since the specified ref
--successCache Enable success caching, which skips running tests for unchanged packages that were successful in the previous run
--successCacheDir <path> Set the success cache location, (default: node_modules/.cache/backstage-cli)
--jest-help Show help for Jest CLI options, which are passed through
-h, --help display help for command
--since <ref> Only test packages that changed since the specified ref
--success-cache Enable success caching, which skips running tests for unchanged packages that were successful in the previous run
--success-cache-dir <path> Set the success cache location, (default: node_modules/.cache/backstage-cli)
--jest-help Show help for Jest CLI options, which are passed through
-h, --help display help for command
```
## package start
@@ -178,7 +178,7 @@ Usage: backstage-cli package start [options]
Start a package for local development
Options:
--config <path> Config files to load instead of app-config.yaml (default: [])
--config <path> Config files to load instead of app-config.yaml (default: [])
--role <name> Run the command with an explicit package role
--check Enable type checking and linting if available
--inspect Enable debugger in Node.js environments
packages/cli-module-test-jest/src/commands/repo/test.test.ts
+1 -1
View File
@@ -84,7 +84,7 @@ describe('repo test arg forwarding', () => {
});
it('supports legacy camelCase flag names', () => {
const args = ['--successCache', '--successCacheDir', '/tmp/cache'];
const args = ['--success-cache', '--success-cache-dir', '/tmp/cache'];
const { flags } = parseRepoTestArgs(args);
packages/cli-module-test-jest/src/commands/repo/test.ts
+3 -3
View File
@@ -319,13 +319,13 @@ export default async ({ args, info }: CliCommandContext) => {
args.push('--help');
}
// This code path is enabled by the --successCache flag, which is specific to
// This code path is enabled by the --success-cache flag, which is specific to
// the `repo test` command in the Backstage CLI.
if (opts.successCache) {
// Refuse to run if file filters are provided
if (parsedArgs.length > 0) {
throw new Error(
`The --successCache flag can not be combined with the following arguments: ${parsedArgs.join(
`The --success-cache flag can not be combined with the following arguments: ${parsedArgs.join(
', ',
)}`,
);
@@ -333,7 +333,7 @@ export default async ({ args, info }: CliCommandContext) => {
// Likewise, it's not possible to combine sharding and the success cache
if (args.includes('--shard')) {
throw new Error(
`The --successCache flag can not be combined with the --shard flag`,
`The --success-cache flag can not be combined with the --shard flag`,
);
}