You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can build a custom image in Depot CI using a job that runs only your setup steps on the Depot base image. After your setup steps complete, the snapshot action captures the state of the sandbox environment and pushes it to the Depot registry as a reusable image. Any job can then use that snapshot as its starting image, skipping the setup steps entirely.
8
10
11
+
<NoteCalloutfullWidth>
12
+
The snapshot action can only be used in workflows running on Depot CI. It is not compatible with GitHub Actions or
13
+
other CI providers.
14
+
</NoteCallout>
15
+
9
16
## Snapshot a sandbox to build a custom image
10
17
11
18
Create a job that runs on a standard Depot sandbox and installs the tools and dependencies you want to bake in. This is a separate workflow that only creates your custom image and pushes it to the Depot Registry. You'll need to run this workflow initially to create the image and then only when dependencies change.
Copy file name to clipboardExpand all lines: content/ci/how-to-guides/manage-secrets-and-variables.mdx
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,16 @@ You can't view secret values in the dashboard after you create them. Variable va
16
16
17
17
Names must be non-empty. Repository-scoped names can't contain a forward slash (`/`).
18
18
19
+
### Import secrets and variables from GitHub
20
+
21
+
If you're migrating from GitHub Actions, you can import your existing GitHub secrets and variables into Depot CI with a single command:
22
+
23
+
```bash
24
+
depot ci migrate secrets-and-vars
25
+
```
26
+
27
+
This creates a one-shot GitHub Actions workflow that reads secrets and variables from your GitHub repository and imports them into Depot CI. See [`depot ci migrate secrets-and-vars`](/docs/cli/reference/depot-ci#depot-ci-migrate-secrets-and-vars) in the CLI reference for details.
28
+
19
29
You can also manage secrets and variables with the Depot CLI. See the [examples](#manage-secrets-and-variables-with-the-cli), or the [full CLI reference](/docs/cli/reference/depot-ci) for all flags and options.
Copy file name to clipboardExpand all lines: content/ci/overview.mdx
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Depot CI is a programmable CI system for engineers and agents. Workflows in Depo
13
13
14
14
Switching to Depot CI starts with one command: `depot ci migrate`.
15
15
16
-
The interactive wizard discovers your GitHub Actions workflows, analyzes them for compatibility, copies the workflows and any local actions to a `.depot/` directory, and prompts you to set values for secrets or variables they reference.
16
+
The interactive wizard helps you install our GitHub App, discovers your GitHub Actions workflows, analyzes them for compatibility, and copies selected workflows and any local actions to a `.depot/` directory. Secrets and variables can then be automatically imported from GitHub in a separate step with `depot ci migrate secrets-and-vars`.
17
17
18
18
Your original `.github/` workflows continue running on GitHub in parallel until you're ready to switch over to Depot CI completely. For a step-by-step walkthrough, see the [quickstart](/docs/ci/quickstart).
19
19
@@ -137,11 +137,11 @@ For the full compatibility matrix, see [Depot CI compatibility with GitHub Actio
137
137
138
138
We track and bill Depot CI sandbox usage by the second, with no one-minute minimum per run. We calculate total seconds used at the end of the billing period.
139
139
140
-
|| Developer plan | Startup plan | Business plan |
@@ -151,17 +151,19 @@ We track and bill Depot CI sandbox usage by the second, with no one-minute minim
151
151
152
152
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.
153
153
154
+
Included monthly Depot CI minutes are not a hard cap. Additional usage is billed automatically.
155
+
154
156
### Depot CI sandbox types
155
157
156
158
Larger sandboxes consume your included Depot CI minutes faster and cost more per second of wall time.
Copy file name to clipboardExpand all lines: content/ci/quickstart.mdx
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,15 +52,28 @@ From the root of your repository, run:
52
52
depot ci migrate
53
53
```
54
54
55
-
The wizard does the following:
55
+
The command runs a preflight check, then copies and transforms your workflows:
56
56
57
-
1.Discovers all workflow files in `.github/workflows/`.
58
-
2.Analyzes each workflow for compatibility with Depot CI and shows a summary of any issues.
57
+
1.Validates authentication and checks that the [Depot Code Access app](#connect-to-github) is installed with the correct permissions.
58
+
2.Discovers all workflow files in `.github/workflows/`.
59
59
3. Prompts you to select which workflows to migrate.
60
-
4. Creates a `.depot/` directory and copies selected workflows (and any local actions from `.github/actions/`) there.
61
-
5. Detects secrets and variables referenced in the selected workflows and prompts you to enter their values.
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.
62
61
63
-
For a full description of flags and non-interactive mode, see [`depot ci migrate`](/docs/cli/reference/depot-ci#depot-ci-migrate) in the Depot CLI reference.
62
+
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.
63
+
64
+
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.
65
+
66
+
## Import secrets and variables
67
+
68
+
If your workflows reference GitHub secrets or variables, use `depot ci migrate secrets-and-vars` to import them into Depot CI:
69
+
70
+
```bash
71
+
depot ci migrate secrets-and-vars
72
+
```
73
+
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.
75
+
76
+
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.
Copy file name to clipboardExpand all lines: content/cli/reference/depot-ci.mdx
+83-30Lines changed: 83 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,62 +14,115 @@ Other Depot product CLI references:
14
14
15
15
## `depot ci migrate`
16
16
17
-
Automates migrating GitHub Actions workflows to Depot CI. Launches an interactive wizard that discovers workflows in `.github/workflows/`, analyzes them for compatibility, copies selected workflows to`.depot/workflows/`, and prompts you to configure any referenced secrets and variables.
17
+
Migrates GitHub Actions workflows to Depot CI. The command runs two phases: it validates your environment with a preflight check, then copies and transforms your selected workflows into`.depot/workflows/`.
18
18
19
19
```bash
20
20
depot ci migrate
21
21
```
22
22
23
-
### What the command does
23
+
After migration, the command reports any secrets and variables referenced by the migrated workflows and directs you to [`depot ci migrate secrets-and-vars`](#depot-ci-migrate-secrets-and-vars) for importing them.
24
+
25
+
Each phase is also available as a standalone subcommand:
26
+
27
+
-[`depot ci migrate preflight`](#depot-ci-migrate-preflight) — validate authentication and GitHub app access
28
+
-[`depot ci migrate workflows`](#depot-ci-migrate-workflows) — copy and transform workflows
29
+
-[`depot ci migrate secrets-and-vars`](#depot-ci-migrate-secrets-and-vars) — import GitHub secrets and variables into Depot CI
|`--yes`| Run in non-interactive mode, migrating all discovered workflows automatically |
36
+
|`--overwrite`| Overwrite an existing `.depot/` directory without prompting |
37
+
|`--org <id>`| Specify a Depot organization ID (required if you belong to more than one organization) |
38
+
|`--token <token>`| Depot API token |
39
+
40
+
---
41
+
42
+
### `depot ci migrate preflight`
43
+
44
+
Validates that you are authenticated, detects the GitHub repository from your git remote, and checks that the Depot Code Access GitHub App is installed with the correct permissions and repository access.
45
+
46
+
```bash
47
+
depot ci migrate preflight
48
+
```
49
+
50
+
If the app is not installed or needs updated permissions, the command prints a link to configure it.
|`--org <id>`| Specify a Depot organization ID (required if you belong to more than one organization) |
57
+
|`--token <token>`| Depot API token |
58
+
59
+
---
60
+
61
+
### `depot ci migrate workflows`
62
+
63
+
Copies workflows from `.github/workflows/` into `.depot/workflows/`, applying Depot CI compatibility transformations and inline comments documenting any changes.
64
+
65
+
```bash
66
+
depot ci migrate workflows
67
+
```
68
+
69
+
#### What the command does
24
70
25
71
1. Discovers all workflow files in `.github/workflows/`.
26
72
2. Analyzes each workflow for compatibility with Depot CI.
27
73
3. Prompts you to select which workflows to migrate.
28
-
4. Creates a `.depot/` directory and copies selected workflows (and any local actions from `.github/actions/`) there.
29
-
5. Detects secrets and variables referenced in the selected workflows and prompts you to enter their values.
74
+
4. Copies selected workflows to `.depot/workflows/` and any local actions from `.github/actions/` to `.depot/actions/`.
75
+
5. Applies compatibility fixes (for example, mapping `ubuntu-latest` to `depot-ubuntu-latest`).
76
+
6. Disables jobs that use unsupported features and adds inline comments explaining what changed.
77
+
7. Reports any secrets and variables detected in the migrated workflows.
|`--yes`| Run in non-interactive mode, migrating all discovered workflows automatically |
91
+
|`--overwrite`| Overwrite an existing `.depot/` directory without prompting |
92
+
|`--org <id>`| Specify a Depot organization ID (required if you belong to more than one organization) |
93
+
|`--token <token>`| Depot API token |
49
94
50
-
###Non-interactive mode
95
+
#### What gets transformed
51
96
52
-
Use `--yes` to run the migration without any prompts. Combine it with `--secret` and `--var` to supply values upfront:
97
+
The command applies three kinds of changes to migrated workflows, documented with inline comments:
98
+
99
+
-**`runs-on` labels** are remapped from GitHub runner labels (like `ubuntu-latest`) to their Depot equivalents.
100
+
-**Unsupported triggers** (like `release` or `schedule`) are removed from the `on:` block with a comment explaining why.
101
+
-**Jobs with unsupported features** are commented out entirely, with a `DISABLED` comment noting the reason.
102
+
103
+
Each migrated file includes a header comment listing the source workflow and a summary of all changes made. For the full compatibility matrix, see [Compatibility with GitHub Actions](/docs/ci/compatibility).
104
+
105
+
---
106
+
107
+
### `depot ci migrate secrets-and-vars`
108
+
109
+
Creates a one-shot GitHub Actions workflow that reads secrets and variables from your GitHub repository and imports them into Depot CI.
53
110
54
111
```bash
55
-
depot ci migrate --yes \
56
-
--secret NPM_TOKEN=npm_abc123 \
57
-
--secret DATABASE_URL=postgres://... \
58
-
--var SERVICE_NAME=api \
59
-
--org my-org-id
112
+
depot ci migrate secrets-and-vars
60
113
```
61
114
62
-
If a workflow references a secret or variable that you haven't supplied via flags, the migration completes with a warning. Add missing values later with `depot ci secrets add` or `depot ci vars add`.
63
-
64
-
### Compatibility analysis
115
+
The command pushes a temporary branch to your GitHub repository containing a workflow that runs on GitHub Actions. The workflow reads your existing GitHub secrets and variables and imports them into Depot CI using the Depot CLI.
65
116
66
-
Before copying any files, the wizard analyzes each workflow and shows a summary of issues:
117
+
In interactive mode, you can preview the generated workflow before it is created. After the workflow is triggered, the command prints a URL where you can monitor the import.
67
118
68
-
-**No issues**: The workflow is fully compatible and safe to migrate.
69
-
-**Warnings**: Features are partially supported. The workflow will run but behavior may differ from GitHub Actions.
70
-
-**Critical issues**: Features are unsupported. The workflow is unlikely to run correctly in Depot CI today.
119
+
#### Flags
71
120
72
-
For the full compatibility matrix, see [Compatibility with GitHub Actions](/docs/ci/compatibility).
0 commit comments