Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/cache/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ ogTitle: Authentication for Depot remote caching
description: Learn how to authenticate with Depot remote caching
---

Depot Cache supports authenticating with **user** tokens and **organization** tokens. Additionally, [Depot-managed GitHub Actions runners](/docs/github-actions/overview) are pre-configured with single-use job tokens.
Depot Cache supports authenticating with **user** tokens and **organization** tokens. Additionally, [Depot GitHub Actions runners](/docs/github-actions/overview) are pre-configured with a token that is active for a single job, which is set as environment variable called `DEPOT_CACHE_TOKEN`.

Project tokens are **not** supported for Depot cache.
Project tokens are **not** supported for Depot cache because only [container builds](/docs/container-builds/overview) use projects.

## Token types

- **User tokens** are used to authenticate as a specific user and can be generated from your [user settings](/settings) page.

- **Organization tokens** are used to authenticate as an organization. These tokens can be generated from your organization's settings page.

- **Depot GitHub Actions runners** are pre-configured with single-use job tokens. If you are using the automatic Depot Cache integration with Depot runners, you do not need to manually configure authentication.
- **Depot GitHub Actions runners** are pre-configured with a token that is active for a single job (`DEPOT_CACHE_TOKEN`). If you are using the automatic Depot Cache integration with Depot runners, you do not need to manually configure authentication.

## Configuring build tools

Expand Down
22 changes: 11 additions & 11 deletions content/cache/integrations/github-actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ ogTitle: Remote caching for GitHub Actions workflows
description: Learn how to use Depot remote caching for GitHub Actions workflows
---

[**Depot Cache**](/docs/cache/overview) provides a remote cache service for GitHub Actions cache when running workflows on Depot-managed GitHub Actions runners, which provides faster upload and download speeds compared to the standard GitHub Actions cache.
[**Depot Cache**](/docs/cache/overview) provides a remote cache service for GitHub Actions cache when running workflows on Depot GitHub Actions runners, which provides faster upload and download speeds compared to the standard GitHub Actions cache.

## Use GitHub Actions cache with Depot Cache

Depot Cache for GitHub Actions is only available when using [Depot GitHub Actions runners](/docs/github-actions/overview). Standard GitHub-hosted runners or self-hosted runners use the standard GitHub Actions cache.

### From Depot-managed Actions runners
### From Depot GitHub Actions runners

[Depot GitHub Actions runners](/docs/github-actions/overview) are pre-configured to use Depot Cache for all GitHub Actions cache operations. When running workflows on Depot runners, any action that uses the GitHub Actions cache API automatically uses Depot Cache instead of the standard GitHub Actions cache.
[Depot GitHub Actions runners](/docs/github-actions/overview) are pre-configured to use Depot Cache for all GitHub Actions cache operations. When running workflows on Depot GitHub Actions runners, any action that uses the GitHub Actions cache API automatically uses Depot Cache instead of the standard GitHub Actions cache.

This includes:

- `actions/cache` - The standard caching action
- `actions/setup-node` - Caches npm/yarn dependencies when you enable the cache option
- `actions/setup-python` - Caches pip dependencies when you enable the cache option
- `actions/setup-java` - Caches Maven/Gradle dependencies when you enable the cache option
- `actions/cache`: the standard caching action
- `actions/setup-node`: caches npm/yarn dependencies when you enable the cache option
- `actions/setup-python`: caches pip dependencies when you enable the cache option
- `actions/setup-java`: caches Maven/Gradle dependencies when you enable the cache option
- Any other action that uses the GitHub Actions cache API

#### Example workflow

A workflow using `actions/cache` automatically uses Depot Cache when running on Depot runners, with no changes to your workflow file:
A workflow using `actions/cache` automatically uses Depot Cache when running on Depot GitHub Actions runners, with no changes to your workflow file:

```yaml
steps:
Expand All @@ -44,9 +44,9 @@ steps:

### Compatibility with other tools

Depot Cache works with any tool or package manager that's compatible with the GitHub Actions cache API. When running on Depot runners, these tools automatically use Depot Cache for faster upload and download speeds.
Depot Cache works with any tool or package manager that's compatible with the GitHub Actions cache API. When running on Depot GitHub Actions runners, these tools automatically use Depot Cache for faster upload and download speeds.

For example, you can configure NX to use the GitHub Actions cache through the [`raegen/nx`](https://github.com/raegen/nx) GitHub Action, which directly integrates with the GitHub Actions cache API, or by using the [`@nx/shared-fs-cache`](https://nx.dev/docs/reference/remote-cache-plugins/shared-fs-cache/overview) package combined with `actions/cache` to manually save and restore the `.nx/cache` directory.
For example, you can configure NX to use the GitHub Actions cache by using the [`@nx/shared-fs-cache`](https://nx.dev/docs/reference/remote-cache-plugins/shared-fs-cache/overview) package combined with `actions/cache` to save and restore the `.nx/cache` directory.

Other build tools and package managers that integrate with GitHub Actions cache similarly work with Depot Cache without additional configuration.

Expand All @@ -67,4 +67,4 @@ Depot Cache doesn't enforce cache isolation based on the branch that runs the jo

### Cache retention and limits

The amount of Depot Cache storage you get depends on [your plan](/pricing). You can configure a cache retention policy (7, 14, or 30 days) and size limits (25 GB to 500 GB, or no limit) in your [organization settings](https://depot.dev/orgs/_/settings). The default cache retention policy is 14 days.
The amount of Depot Cache storage you get depends on [your plan](/pricing). You can configure a cache retention policy (7, 14, or 30 days) and size limits (25 GB to 500 GB, or no limit) in your [organization settings](/orgs/_/settings). The default retention policy is 14 days with no size limit.
Loading
Loading