BYOK signature uses TURBO_REMOTE_CACHE_SIGNATURE_KEY env variable by default
#963
Conversation
Needs followup on 'remoteCache' option documentation to include remoteOnly, teamId explanation.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/vercel/turbo-site/JEEpV4AWDh521yK4DTTZswewshMd |
| ```jsonc | ||
| { | ||
| "$schema": "https://turborepo.org/schema.json", | ||
| "remoteCache": { |
There was a problem hiding this comment.
I think we might need a section defining the remoteCache similar to https://turborepo.org/docs/features/pipelines#defining-a-pipeline
There was a problem hiding this comment.
depends on how we want to introduce --remote-only and teamId enforcement from turbo.json
|
Let’s write the docs for remote only in another PR and then we can implement it. A little docs-driven development |
| // used for signing and verifying signatures. You can use any | ||
| // environment variable name. | ||
| "keyEnv": "TURBO_REMOTE_CACHE_SIGNATURE_KEY", | ||
| // The secret key to use for signing and verifying signatures. |
There was a problem hiding this comment.
Why would you ever commit this? or is this a path to a txt file?
There was a problem hiding this comment.
It is the plaintext secret key. I added it here as a way to test changes to the key value. I considered adding a note saying that using key is not recommended.
Would you prefer we remove support for that key and only allow env variable keys for now?
There was a problem hiding this comment.
I think only env var keys for now makes sense
There was a problem hiding this comment.
What's the thinking behind making the key name configurable? Why not just TURBO_REMOTE_CACHE_SIGNATURE_KEY?
There was a problem hiding this comment.
This was forward looking to supporting multiple signature schemes, if needed at some point.
…cache options Use preset `TURBO_REMOTE_CACHE_SIGNATURE_KEY` environment variable name to set the key for signatures
TURBO_REMOTE_CACHE_SIGNATURE_KEY env variable by default
Remote support for turbo.json's plaintext key and configurable environment keyEnv name
Update docs.