Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Docs: How to replace --force with new --cache flag #9453

Open
robinscholz opened this issue Nov 18, 2024 · 0 comments
Open

📚 Docs: How to replace --force with new --cache flag #9453

robinscholz opened this issue Nov 18, 2024 · 0 comments

Comments

@robinscholz
Copy link

What is the improvement or update you wish to see?

When setting a --force flag on a task, I ran into an error related to the newly implemented cache flag and its default value.

Cannot set `cache` config and other cache options (`force`, `remoteOnly`,`remoteCacheReadOnly`) at the same time.

It would be great if the docs could explain how to replace --force with a --cache= flag to avoid triggering this error.

Is there any context that might help us understand?

This happened while deploying to vercel with turbo run build --filter=docs

Does the docs page already exist? Please link to it.

No response

@robinscholz robinscholz changed the title 📚 Docs: --force and --cache seem to interact somehow 📚 Docs: How to replace --force with new --cache flag Nov 18, 2024
chris-olszewski added a commit that referenced this issue Nov 18, 2024
### Description

As mentioned in #9453 if a user sets `--force` when `TURBO_CACHE` is set
we currently error. `--force` should be applicable in this case an just
remove any reads from the `TURBO_CACHE` setting.

### Testing Instructions

Updated unit test, manual verification of behavior for other cases:
```
# Do not allow `--force` and `--cache`
[0 olszewski@chriss-mbp] /Users/olszewski/code/vercel/turborepo $ turbo_dev @turbo/types#build --force --cache=local:rw 
 WARNING  No locally installed `turbo` found. Using version: 2.3.1-canary.0.
 ERROR  the argument '--force [<FORCE>]' cannot be used with '--cache <CACHE>'

Usage: turbo --force [<FORCE>]

For more information, try '--help'.

# Force should remove reads even if set from env var
[1 olszewski@chriss-mbp] /Users/olszewski/code/vercel/turborepo $ TURBO_FORCE=1 turbo_dev @turbo/types#build --cache=local:rw       
 WARNING  No locally installed `turbo` found. Using version: 2.3.1-canary.0.
turbo 2.3.1-canary.0

• Packages in scope: @turbo-internal/top-issues-gh-action, @turbo/benchmark, @turbo/codemod, @turbo/eslint-config, @turbo/exe-stub, @turbo/gen, @turbo/telemetry, @turbo/test-utils, @turbo/tsconfig, @turbo/types, @turbo/utils, @turbo/workspaces, @turborepo-examples-tests/basic, @turborepo-examples-tests/design-system, @turborepo-examples-tests/kitchen-sink, @turborepo-examples-tests/non-monorepo, @turborepo-examples-tests/with-berry, @turborepo-examples-tests/with-changesets, @turborepo-examples-tests/with-npm, @turborepo-examples-tests/with-react-native-web, @turborepo-examples-tests/with-rollup, @turborepo-examples-tests/with-svelte, @turborepo-examples-tests/with-tailwind, @turborepo-examples-tests/with-vite, @turborepo-examples-tests/with-yarn, cargo-sweep-action, cli, create-turbo, eslint-config-turbo, eslint-plugin-turbo, prysk, turbo-ignore, turbo-vsc, turborepo-examples, turborepo-repository, turborepo-tests-helpers, turborepo-tests-integration
• Running @turbo/types#build in 37 packages
• Remote caching disabled
┌ @turbo/types#build > cache bypass, force executing 378250748b4bc15b 
│ 
│ 
│ > @turbo/[email protected] build /Users/olszewski/code/vercel/turborepo/packages/turbo-types
│ > tsc && pnpm generate-schema
│ 
│ 
│ > @turbo/[email protected] generate-schema /Users/olszewski/code/vercel/turborepo/packages/turbo-types
│ > tsx scripts/generate-schema.ts
└────>

 Tasks:    1 successful, 1 total
Cached:    0 cached, 1 total
  Time:    3.045s 

# `--force` removes reads from `TURBO_CACHE` settings
[0 olszewski@chriss-mbp] /Users/olszewski/code/vercel/turborepo $ TURBO_CACHE=local:rw turbo_dev @turbo/types#build --force         
 WARNING  No locally installed `turbo` found. Using version: 2.3.1-canary.0.
turbo 2.3.1-canary.0

• Packages in scope: @turbo-internal/top-issues-gh-action, @turbo/benchmark, @turbo/codemod, @turbo/eslint-config, @turbo/exe-stub, @turbo/gen, @turbo/telemetry, @turbo/test-utils, @turbo/tsconfig, @turbo/types, @turbo/utils, @turbo/workspaces, @turborepo-examples-tests/basic, @turborepo-examples-tests/design-system, @turborepo-examples-tests/kitchen-sink, @turborepo-examples-tests/non-monorepo, @turborepo-examples-tests/with-berry, @turborepo-examples-tests/with-changesets, @turborepo-examples-tests/with-npm, @turborepo-examples-tests/with-react-native-web, @turborepo-examples-tests/with-rollup, @turborepo-examples-tests/with-svelte, @turborepo-examples-tests/with-tailwind, @turborepo-examples-tests/with-vite, @turborepo-examples-tests/with-yarn, cargo-sweep-action, cli, create-turbo, eslint-config-turbo, eslint-plugin-turbo, prysk, turbo-ignore, turbo-vsc, turborepo-examples, turborepo-repository, turborepo-tests-helpers, turborepo-tests-integration
• Running @turbo/types#build in 37 packages
• Remote caching disabled
┌ @turbo/types#build > cache bypass, force executing 378250748b4bc15b 
│ 
│ 
│ > @turbo/[email protected] build /Users/olszewski/code/vercel/turborepo/packages/turbo-types
│ > tsc && pnpm generate-schema
│ 
│ 
│ > @turbo/[email protected] generate-schema /Users/olszewski/code/vercel/turborepo/packages/turbo-types
│ > tsx scripts/generate-schema.ts
└────>

 Tasks:    1 successful, 1 total
Cached:    0 cached, 1 total
  Time:    2.284s 
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant