Skip to content

Commit 2bf8e5e

Browse files
docs: clarify TURBO_TEAM secret usage (#10795)
### Description This updates the documentation to clarify how to set the `TURBO_TEAM` secret using the team slug from the Vercel team URL. ### Testing Instructions Updated pages: - Branch URL - https://turbo-site-git-vikhyath-clarify-remote-cache-vars.vercel.sh - Check the updated paths: - [_docs/guides/ci-vendors/github-actions_](https://turbo-site-git-vikhyath-clarify-remote-cache-vars.vercel.sh/docs/guides/ci-vendors/github-actions), - [ _/docs/guides/ci-vendors/circleci_](https://turbo-site-git-vikhyath-clarify-remote-cache-vars.vercel.sh/docs/guides/ci-vendors/circleci), - [_/docs/guides/ci-vendors/gitlab-ci_](https://turbo-site-git-vikhyath-clarify-remote-cache-vars.vercel.sh/docs/guides/ci-vendors/gitlab-ci), - [_/docs/guides/ci-vendors/travis-ci_](https://turbo-site-git-vikhyath-clarify-remote-cache-vars.vercel.sh/docs/guides/ci-vendors/travis-ci)
1 parent ed78e13 commit 2bf8e5e

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

docs/site/content/docs/guides/ci-vendors/circleci.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Create a file called `.circleci/config.yml` in your repository with the followin
182182
To use Remote Caching, retrieve the team and token for the Remote Cache for your provider. In this example, we'll use [Vercel Remote Cache](https://vercel.com/docs/monorepos/remote-caching):
183183
184184
- `TURBO_TOKEN` - The Bearer token to access the Remote Cache
185-
- `TURBO_TEAM` - The account to which the monorepo belongs
185+
- `TURBO_TEAM` - The slug of the Vercel team to share the artifacts with
186186

187187
To use Vercel Remote Caching, you can get the value of these variables in a few steps:
188188

@@ -197,6 +197,6 @@ Copy the value to a safe place. You'll need it in a moment.
197197
![CircleCI Environment Variables](/images/docs/circleci-environment-variables.png)
198198
![CircleCI Create Environment Variables](/images/docs/circleci-create-environment-variables.png)
199199

200-
3. Make a second secret called `TURBO_TEAM` and enter [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL).
200+
3. Make a second secret called `TURBO_TEAM` and set it to your team slug - the part after `vercel.com/` in [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL). For example, the slug for `vercel.com/acme` is `acme`.
201201

202202
4. CircleCI automatically loads environment variables stored in project settings into the CI environment. No modifications are necessary for the CI file.

docs/site/content/docs/guides/ci-vendors/github-actions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ To use Remote Caching with GitHub Actions, add the following environment variabl
235235
to make them available to your `turbo` commands.
236236

237237
- `TURBO_TOKEN` - The Bearer token to access the Remote Cache
238-
- `TURBO_TEAM` - The account to which the repository belongs
238+
- `TURBO_TEAM` - The slug of the Vercel team to share the artifacts with
239239

240240
To use Remote Caching, retrieve the team and token for the Remote Cache for your provider. In this example, we'll use [Vercel Remote Cache](https://vercel.com/docs/monorepos/remote-caching).
241241

@@ -257,7 +257,7 @@ Go to your GitHub repository settings and click on the **Secrets** and then **Ac
257257
</Step>
258258

259259
<Step>
260-
Create a new repository variable (click the **Variables** tab) called `TURBO_TEAM` and enter [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL).
260+
Create a new repository variable (click the **Variables** tab) called `TURBO_TEAM` and set it to your team slug - the part after `vercel.com/` in [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL). For example, the slug for `vercel.com/acme` is `acme`.
261261

262262
<Callout type="good-to-know">
263263
Using a repository variable rather than a secret will keep GitHub Actions from

docs/site/content/docs/guides/ci-vendors/gitlab-ci.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Create a file called `.gitlab-ci.yml` in your repository with the following cont
134134
To use Remote Caching, retrieve the team and token for the Remote Cache for your provider. In this example, we'll use [Vercel Remote Cache](https://vercel.com/docs/monorepos/remote-caching):
135135

136136
- `TURBO_TOKEN` - The Bearer token to access the Remote Cache
137-
- `TURBO_TEAM` - The account to which the repository belongs
137+
- `TURBO_TEAM` - The slug of the Vercel team to share the artifacts with
138138

139139
To use Vercel Remote Caching, you can get the value of these variables in a few steps:
140140

@@ -149,6 +149,6 @@ Copy the value to a safe place. You'll need it in a moment.
149149
![GitLab CI Variables](/images/docs/gitlab-ci-variables.png)
150150
![GitLab CI Create Variable](/images/docs/gitlab-ci-create-variable.png)
151151

152-
3. Make a second secret called `TURBO_TEAM` and enter [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL).
152+
3. Make a second secret called `TURBO_TEAM` and set it to your team slug - the part after `vercel.com/` in [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL). For example, the slug for `vercel.com/acme` is `acme`.
153153

154154
Remote Caching will now be operational in your GitLab workflows.

docs/site/content/docs/guides/ci-vendors/travis-ci.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Create a file called `.travis.yml` in your repository with the following content
127127
To use Remote Caching, retrieve the team and token for the Remote Cache for your provider. In this example, we'll use [Vercel Remote Cache](https://vercel.com/docs/monorepos/remote-caching):
128128

129129
- `TURBO_TOKEN` - The Bearer token to access the Remote Cache
130-
- `TURBO_TEAM` - The account to which the monorepo belongs
130+
- `TURBO_TEAM` - The slug of the Vercel team to share the artifacts with
131131

132132
To use Vercel Remote Caching, you can get the value of these variables in a few steps:
133133

@@ -141,6 +141,6 @@ Copy the value to a safe place. You'll need it in a moment.
141141

142142
![Travis CI Variables](/images/docs/travis-ci-environment-variables.png)
143143

144-
3. Make a second secret called `TURBO_TEAM` and enter [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL).
144+
3. Make a second secret called `TURBO_TEAM` and set it to your team slug - the part after `vercel.com/` in [your Team URL](https://vercel.com/d?to=%2F%5Bteam%5D%2F%7E%2Fsettings&title=Find+Team+URL). For example, the slug for `vercel.com/acme` is `acme`.
145145

146146
4. Travis CI automatically loads environment variables stored in project settings into the CI environment. No modifications are necessary for the CI file.
-128 Bytes
Loading

0 commit comments

Comments
 (0)