Skip to content

Commit aec1416

Browse files
Akatamagithub-actions[bot]
authored andcommitted
Update docs content from https://github.com/depot/app
1 parent 0bf9339 commit aec1416

6 files changed

Lines changed: 33 additions & 22 deletions

File tree

content/ci/compatibility.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ Depot CI executes GitHub Actions YAML workflows. The following tables list GitHu
113113
| `success()` | Run if no failures ||
114114
| `failure()` | Run if any failure ||
115115
| `cancelled()` | Run if cancelled ||
116+
| `case()` | Conditional value select ||
116117
| `hashFiles()` | File hashing for caching ||
117118
| `contains()` | String/array contains ||
118119
| `startsWith()` | String prefix check ||
@@ -183,7 +184,7 @@ Custom runner images via the `snapshot` field aren't supported. You can still [b
183184

184185
### Runner labels
185186

186-
Only Depot `runs-on` labels are supported. Any label that Depot doesn't recognize is treated as `depot-ubuntu-latest`.
187+
Only Depot `runs-on` labels are supported. Nonstandard labels become `depot-ubuntu-latest` and expressions are preserved as-is. For Depot CI sandbox sizes and labels, see [Depot CI sandboxes](/docs/ci/overview#depot-ci-sandboxes).
187188

188189
### Permissions
189190

content/ci/how-to-guides/custom-images.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ Available values for `size`:
8989
| `32x128` | 32 | 128 GB |
9090
| `64x256` | 64 | 256 GB |
9191

92+
For sandbox information and pricing, see [Depot CI sandboxes](/docs/ci/overview#depot-ci-sandboxes).
93+
9294
## Environment variable changes don't persist in custom images
9395

9496
For actions that set or change environment variables, you need to include the steps in both the image build workflow and the workflows that use the custom image.

content/ci/overview.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ For the full compatibility matrix, see [Depot CI compatibility with GitHub Actio
135135

136136
## Pricing
137137

138-
Depot CI sandbox usage is tracked and billed by the second, with no one-minute minimum per run. The minutes included with each plan are based on the smallest sandbox size (2 CPUs/8 GB). See [Depot CI sandbox sizes](#depot-ci-sandbox-sizes).
138+
Depot CI sandbox usage is tracked and billed by the second, with no one-minute minimum per run. The minutes included with each plan are based on the smallest sandbox size (2 CPUs/8 GB). The included plan minutes aren't a hard cap. Additional usage is billed automatically. For sandbox sizes and additional usage pricing, see [Depot CI sandboxes](#depot-ci-sandboxes).
139139

140140
| | Developer plan | Startup plan | Business plan |
141141
| -------------------- | --------------------------------------------------- | ---------------------------------------------------- | ------------- |
@@ -151,13 +151,13 @@ Depot CI sandbox usage is tracked and billed by the second, with no one-minute m
151151

152152
Plans also include [container build](/docs/container-builds/overview) minutes and [GitHub Actions runner](/docs/github-actions/overview) minutes. See [Pricing](/pricing) for more about plan features and costs.
153153

154-
The Depot CI minutes included in your monthly plan are not a hard cap. Additional usage is billed automatically.
154+
## Depot CI sandboxes
155155

156-
### Depot CI sandbox sizes
156+
Depot CI runs your workflows in x86_64 sandboxes. Sandboxes can use from 2 CPUs/8 GB of memory up to 64 CPUs/256 GB of memory. The default sandbox image is based on Ubuntu 24.04.
157157

158-
Larger sandboxes consume your included Depot CI minutes faster and cost more per second for extra usage. For example, a 4-CPU sandbox uses 2 minutes for every 1 minute of running time.
158+
Larger sandboxes consume the Depot CI minutes included in your plan faster and cost more per second for extra usage. For example, a 4-CPU sandbox uses 2 minutes for every 1 minute of running time.
159159

160-
Use the labels from the following table in the `runs-on` key of your workflow. Use the sandbox size when referencing a [custom image](/docs/ci/how-to-guides/custom-images).
160+
Use a _Label_ from the following table in the `runs-on` key of your workflow. For [custom images](/docs/ci/how-to-guides/custom-images), use a _Sandbox size_ paired with a Depot Registry custom image URL in the `runs-on` key.
161161

162162
| Label | Sandbox size | CPUs | Memory | Per-second price | Plan minutes multiplier |
163163
| :---------------------- | :----------- | :--- | :----- | :--------------- | :---------------------- |
@@ -168,6 +168,8 @@ Use the labels from the following table in the `runs-on` key of your workflow. U
168168
| `depot-ubuntu-24.04-32` | `32x128` | 32 | 128 GB | $0.0016 | 16x |
169169
| `depot-ubuntu-24.04-64` | `64x256` | 64 | 256 GB | $0.0032 | 32x |
170170

171+
Depot CI doesn't provide sandboxes for Arm, macOS, or Windows. Labels for these runner types (as listed in [Depot GitHub Actions runner types](/docs/github-actions/runner-types)) aren't compatible with Depot CI.
172+
171173
## FAQ
172174

173175
<FAQSection>

content/ci/quickstart.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,16 @@ The command runs a preflight check, then copies and transforms your workflows:
5757
1. Validates authentication and checks that the [Depot Code Access app](#connect-to-github) is installed with the correct permissions.
5858
2. Discovers all workflow files in `.github/workflows/`.
5959
3. Prompts you to select which workflows to migrate.
60-
4. Copies selected workflows to `.depot/workflows/` and any local actions to `.depot/actions/`, applying compatibility fixes and adding inline comments for any changes.
60+
4. Copies selected workflows to `.depot/workflows/` and any local actions to `.depot/actions/`, applies compatibility fixes, and adds inline comments for any changes.
6161

6262
After migration, the command reports any secrets and variables referenced by the migrated workflows. To import them, see [Import secrets and variables](#import-secrets-and-variables) below.
6363

6464
For a full description of flags and subcommands, see [`depot ci migrate`](/docs/cli/reference/depot-ci#depot-ci-migrate) in the Depot CLI reference.
6565

66+
### Sandbox sizes
67+
68+
The `depot ci migrate` command changes standard `ubuntu-24.x` or `ubuntu-latest` runner labels in your workflow to the equivalent Depot CI sandbox label and notes the change in the migrated file. Nonstandard labels become `depot-ubuntu-latest` and expressions are preserved as-is. For Depot CI sandbox sizes and labels, see [Depot CI sandboxes](/docs/ci/overview#depot-ci-sandboxes).
69+
6670
## Import secrets and variables
6771

6872
If your workflows reference GitHub secrets or variables, use `depot ci migrate secrets-and-vars` to import them into Depot CI:
@@ -71,7 +75,7 @@ If your workflows reference GitHub secrets or variables, use `depot ci migrate s
7175
depot ci migrate secrets-and-vars
7276
```
7377

74-
This creates a one-shot GitHub Actions workflow that reads your existing GitHub secrets and variables and imports them into Depot CI. The command prints a URL where you can monitor the import.
78+
This command creates a one-shot GitHub Actions workflow that reads your existing GitHub secrets and variables and imports them into Depot CI. The command prints a URL where you can monitor the import.
7579

7680
You can also add secrets and variables manually with `depot ci secrets add` and `depot ci vars add`, or from the [Depot CI settings](https://depot.dev/orgs/_/workflows/settings) in the dashboard. See [Manage secrets and variables](/docs/ci/how-to-guides/manage-secrets-and-variables) for details.
7781

content/container-builds/build-parallelism.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ When the same instruction is being built multiple times on the same runner, you
121121

122122
When Build A starts building at 10:00 AM, it pulls the base image and runs `npm ci`, creating new layers. When Build B starts building just a minute later at 10:01 AM, BuildKit recognizes that it needs the same base image and has the same `npm ci` command. Instead of duplicating this work, Build B waits for Build A to complete those steps, then reuses the layers that Build A created.
123123

124-
The deduplication process generally improves overall efficiency, but can be confusing when monitoring individual build times. To avoid overwhelming a single build server, you can enable [build auto-scaling](./how-to-guides/autoscaling) to some particular maximum parallelism value.
124+
The deduplication process generally improves overall efficiency, but can be confusing when monitoring individual build times. To avoid overwhelming a single build server, you can enable [build auto-scaling](/docs/container-builds/how-to-guides/autoscaling) to some particular maximum parallelism value.
125125

126126
#### Docker Bake for orchestrated builds
127127

@@ -195,7 +195,7 @@ Trade-offs:
195195

196196
#### Configuration
197197

198-
For detailed instructions on enabling and configuring auto-scaling, see the [Auto-scaling documentation](./how-to-guides/autoscaling).
198+
For detailed instructions on enabling and configuring auto-scaling, see the [Auto-scaling documentation](/docs/container-builds/how-to-guides/autoscaling).
199199

200200
**Poor cache performance with auto-scaling**
201201

content/github-actions/runner-types.mdx

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
2-
title: GitHub Actions Runner types
2+
title: Depot GitHub Actions runner types
33
ogTitle: Types of Depot-managed GitHub Action Runners
4-
description: Depot offers several different types of GitHub Actions runners, depending on your CI job needs.
4+
description: Depot offers several different types of GitHub Actions runners, depending on your needs.
55
---
66

7-
Depot offers several different types of GitHub Actions runners, depending on your CI job needs. You can choose the type on a per-job basis by specifying the runner label in your `.github/workflows/*.yaml` file:
7+
This page lists Depot GitHub Actions runner types and sizes. For Depot CI, see [Depot CI sandboxes](/docs/ci/overview#depot-ci-sandboxes).
8+
9+
Depot offers several different types of GitHub Actions runners. You can choose the type on a per-job basis by specifying the runner label in your `.github/workflows/*.yaml` file:
810

911
```yaml
1012
jobs:
@@ -16,7 +18,7 @@ jobs:
1618

1719
**In-memory Disk Accelerator**:
1820

19-
Depot runners reserve a portion of the memory on the runner host for a disk accelerator, backed by a RAM disk. The accelerator acts as buffer between reading and writing to the root disk, which allows Actions runs to perform incredibly fast I/O operations, much quicker than the physical disk would allow.
21+
Depot Linux and macOS runners reserve a portion of the memory on the runner host for a disk accelerator, backed by a RAM disk. The accelerator acts as buffer between reading and writing to the root disk, which allows Actions runs to perform incredibly fast I/O operations, much quicker than the physical disk would allow.
2022

2123
## Intel runners
2224

@@ -71,7 +73,7 @@ The following labels are available:
7173

7274
## Windows runners
7375

74-
Windows runners use instances with Intel chips running Windows Server 2022 or Windows Server 2025. [Ultra Runners](/blog/introducing-github-actions-ultra-runners) aren't available for Windows runners.
76+
Windows runners use instances with Intel chips running Windows Server 2022 or Windows Server 2025.
7577

7678
**Note**: We support the `depot-windows-latest` if you prefer to use an evergreen version. This label is currently an alias for Window Server 2025.
7779

@@ -109,10 +111,10 @@ macOS runners use instances with M2 chips running macOS 14 or macOS 15. Their EB
109111

110112
The following labels are available:
111113

112-
| Label | CPUs | Memory | Disk size | Per-minute price |
113-
| :-------------------------------------- | :--- | :----- | :-------- | :--------------- |
114-
| `depot-macos-15` (`depot-macos-latest`) | 8 | 24 GB | 400 GB | $0.08 |
115-
| `depot-macos-14` | 8 | 24 GB | 400 GB | $0.08 |
114+
| Label | CPUs | Memory | Disk size | Disk accelerator size | Per-minute price |
115+
| :-------------------------------------- | :--- | :----- | :-------- | :-------------------- | :--------------- |
116+
| `depot-macos-15` (`depot-macos-latest`) | 8 | 24 GB | 400 GB | 2 GB | $0.08 |
117+
| `depot-macos-14` | 8 | 24 GB | 400 GB | 2 GB | $0.08 |
116118

117119
**Note:** due to licensing constraints from Apple, our macOS runner capacity is not fully elastic like our other runner types. We periodically update capacity to match demand, but macOS jobs can experience longer queue times during times of high demand.
118120

@@ -131,9 +133,9 @@ If you'd like to see what tools and software are installed in each runner image,
131133

132134
- [`depot-ubuntu-24.04`](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md) and `depot-ubuntu-latest`
133135
- [`depot-ubuntu-22.04`](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md)
134-
- [`depot-macos-14`](https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md) and `depot-macos-latest`
135-
- [`depot-macos-15`](https://github.com/actions/runner-images/blob/main/images/macos/macos-15-Readme.md)
136-
- [`depot-windows-2025`](https://github.com/actions/runner-images/blob/main/images/windows/Windows2025-Readme.md)
136+
- [`depot-macos-15`](https://github.com/actions/runner-images/blob/main/images/macos/macos-15-Readme.md) and `depot-macos-latest`
137+
- [`depot-macos-14`](https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md)
138+
- [`depot-windows-2025`](https://github.com/actions/runner-images/blob/main/images/windows/Windows2025-Readme.md) and `depot-windows-latest`
137139
- [`depot-windows-2022`](https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md)
138140

139141
_Note: We do our best to keep our images in sync with GitHub's, but there may be a slight delay between when GitHub updates their images and when we update ours. If you need a specific version of a tool or software, please check the links above to see if it's available in the image you're using._

0 commit comments

Comments
 (0)