handle VERCEL_ARTIFACTS_* env vars override #9249
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
8 Skipped Deployments
|
dimitropoulos
force-pushed
the
dimitri/vercel-env-vars-override
branch
from
cc28be2 to
5de06ba
Compare
dimitropoulos
changed the title
dimitropoulos
commented
Oct 16, 2024
dimitropoulos
commented
Oct 16, 2024
dimitropoulos
commented
Oct 16, 2024
chris-olszewski
requested changes
Oct 16, 2024
There was a problem hiding this comment.
This is an amazing write up of the existing + desired behavior.
The only blocking comment is making sure that we keep the same level of user facing error messaging if we encounter a non-UTF8 value.
I feel that changing the parameter for get_configuration_options doesn't provide us with much, but that's just an opinion.
chris-olszewski
approved these changes
Oct 17, 2024
chris-olszewski
approved these changes
Oct 17, 2024
turbo-orchestrator
bot
added
the
area: docs
|
Hi there 👋 It looks like this PR introduces broken links to the docs, please take a moment to fix them before merging:
Thank you 🙏 |
dimitropoulos
force-pushed
the
dimitri/vercel-env-vars-override
branch
from
531c833 to
65a4203
Compare
turbo-orchestrator
bot
removed
the
area: docs
tknickman
approved these changes
Oct 18, 2024
| - ConfigurationOptions.token corresponds to TURBO_TOKEN or VERCEL_ARTIFACTS_TOKEN | ||
| - ConfigurationOptions.team_id corresponds to TURBO_TEAMID or VERCEL_ARTIFACTS_OWNER | ||
| - ConfigurationOptions.team_slug corresponds to TURBO_TEAM | ||
| 1. We're ultimately poking around the env vars looking for _paris_ that make sense. |
There was a problem hiding this comment.
Suggested change
| 1. We're ultimately poking around the env vars looking for _paris_ that make sense. | |
| 1. We're ultimately poking around the env vars looking for _pairs_ that make sense. |
Comment on lines
+10
to
+17
| Hi! If you're new here: | ||
| 1. The general pattern is that: | ||
| - ConfigurationOptions.token corresponds to TURBO_TOKEN or VERCEL_ARTIFACTS_TOKEN | ||
| - ConfigurationOptions.team_id corresponds to TURBO_TEAMID or VERCEL_ARTIFACTS_OWNER | ||
| - ConfigurationOptions.team_slug corresponds to TURBO_TEAM | ||
| 1. We're ultimately poking around the env vars looking for _pairs_ that make sense. | ||
| Since we presume that users are the only ones sending TURBO_* and Vercel is the only one sending VERCEL_*, we can make some assumptions. Namely, we assume that if we have one of VERCEL_ARTIFACTS_OWNER or VERCEL_ARTIFACTS_TOKEN we will always have both. | ||
| 1. Watch out for mixing up `TURBO_TEAM` and `TURBO_TEAMID`. Same for ConfigurationOptions.team_id and ConfigurationOptions.team_slug. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The prior intended state of EnvVars overrides looked like this:
But we've realized this is not good enough. We want to better handle the scenario where users have provided custom remote cache - even if they deploy on Vercel.
After this PR, the precedence works like this.
TURBO_TEAMID+TURBO_TOKENare set we use those. ifTURBO_TEAMis also set, we pass that along, too.TURBO_TEAM+TURBO_TOKENare set we use those. ifTURBO_TEAMIDis also set we pass that along, too.VERCEL_ARTIFACTS_OWNER+VERCEL_ARTIFACTS_TOKENare set, we use those (all else is ignored).TURBO_TEAMID+TURBO_TEAM, we pass those along.TURBO_TEAMIDis set, we pass that along.TURBO_TEAMis set, we pass that along.TURBO_TEAMandVERCEL_ARTIFACTS_OWNERare set, we pass those alongVERCEL_ARTIFACTS_OWNERis set, we pass that alongVERCEL_ARTIFACTS_TOKENandTURBO_TEAMIDare set, this is considered undefined/unsupported behavior. The reasons are that:VERCEL_ARTIFACTS_*familyTesting Instructions
Take a look at the newly added tests in
override_env.rs. You could run turbo while manually setting those same env vars.