Skip to content

Commit 5694d0c

Browse files
nagypeterjobgithub-actions[bot]
authored andcommitted
Update docs content from https://github.com/depot/app
1 parent 56a6ff7 commit 5694d0c

File tree

6 files changed

+95
-4
lines changed

6 files changed

+95
-4
lines changed

content/cli/reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@ Additional flags that can be used with this command.
665665

666666
### `depot pull-token`
667667

668-
Generate a short-lived token to pull an image from the Depot Registry.
668+
Generate a short-lived token (valid for 1 hour) to pull an image from the Depot Registry.
669669

670670
**Example**
671671

content/container-builds/troubleshooting.mdx

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,27 @@ If you're hitting Docker Hub rate limits, you can authenticate with a Docker Hub
161161

162162
To authenticate, create a Docker Hub account if you don't have one, then set up authentication in your build environment.
163163

164+
## Error: `failed to load ref`
165+
166+
If you encounter a warning during container builds similar to:
167+
168+
```text
169+
ERROR: failed to load ref: 05e0j9uordhz0b72g9h3e32an: not found
170+
```
171+
172+
This error indicates that BuildKit couldn't find a cached layer that it expected to exist. While this appears as an error in the logs, BuildKit typically recovers by rebuilding the missing layer, so your build should still complete successfully.
173+
174+
### How to resolve
175+
176+
If you observe this warning frequently, increase the cache storage allocation:
177+
178+
1. Log in to your [Depot Dashboard](https://depot.dev).
179+
2. Select the project and click **Settings**.
180+
3. Increase one or both of **Cache Storage Policy** and **Cache Retention Policy** values.
181+
4. Monitor your builds to verify if the fix worked.
182+
183+
If you continue to see this warning after adjusting your cache settings, [reach out to support](/help) with your project ID and build details.
184+
164185
## Error: `.git directory not found in build context`
165186

166187
When using Depot's `build-push-action` for Docker builds, you might encounter an error such as:
@@ -207,6 +228,35 @@ For more information, refer to the [Docker documentation on keeping the git dire
207228
208229
If you continue to see git-related errors after adding this build argument, verify that your checkout step is fetching the necessary git history and [reach out to support](/help) if needed.
209230
231+
## Error: `cannot merge resource due to conflicting Schema URL`
232+
233+
When running `depot build` or `depot bake`, you may encounter an error message like:
234+
235+
```text
236+
Error: cannot merge resource due to conflicting Schema URL
237+
```
238+
239+
This error is typically caused by conflicting OpenTelemetry (OTEL) environment variables set in your local build environment. These environment variables can interfere with Depot's internal telemetry system.
240+
241+
### How to resolve
242+
243+
Set the environment variable `DEPOT_DISABLE_OTEL=1` in your environment before running `depot build`. This variable disables the embedded OpenTelemetry tracing in Depot CLI. Use this to prevent conflicts when your environment has existing OpenTelemetry instrumentation:
244+
245+
```bash
246+
export DEPOT_DISABLE_OTEL=1
247+
depot build .
248+
```
249+
250+
Alternatively, you can set it inline with your build command:
251+
252+
```bash
253+
DEPOT_DISABLE_OTEL=1 depot build .
254+
```
255+
256+
If you're using a CI/CD environment, add `DEPOT_DISABLE_OTEL=1` to your environment variables for the build step.
257+
258+
If the error persists after setting this environment variable, [reach out to support](/help) with your project ID and build details.
259+
210260
## Error: `remote error: tls: bad record MAC`
211261

212262
When building container images, you may encounter an error like:
@@ -231,9 +281,28 @@ This error is typically caused by network instability on the client side. Check
231281

232282
If you continue experiencing connection issues from your local machine, consider triggering builds from a CI platform instead. CI environments typically have more stable network connections and are better suited for running longer builds. See our [CI integration guides](/docs/container-builds/quickstart#continuous-integration) for setup instructions.
233283

284+
## Error: `timed out connecting to machine: failed to create temp file`
285+
286+
When running a build with Depot CLI, you may encounter an error similar to:
287+
288+
```text
289+
Error: timed out connecting to machine: failed to create temp file: open /var/folders/zz/zyxvpxvq6csfxvn_n0000000000000/T/depot-cert4068571078: permission denied
290+
```
291+
292+
This error indicates that Depot CLI is unable to write the TLS certificate file to a temporary directory on your local machine. The client-side TLS certificate is required to establish secure communication with the remote build server.
293+
294+
### How to resolve
295+
296+
- Try restarting your terminal session
297+
- Check available disk space on your local machine
298+
- Verify your user has write permissions to the directory shown in the error message
299+
- If using an antivirus or other security software, check if it's blocking file operations on the temporary directory
300+
301+
If the issue persists, [reach out to support](/help) with your OS version and any security software you're running.
302+
234303
## Build hangs or builder won't start
235304

236-
If your build is hung or a builder isn't coming online to serve build requests, this may be caused by:
305+
If your build hangs or a builder isn't coming online to serve build requests, this may be caused by:
237306

238307
- A deadlock in BuildKit
239308
- A builder that isn't coming online to serve the build request

content/faq.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,3 +138,11 @@ Our high-performance caching system is automatically integrated with our GitHub
138138
### How can I track usage of Depot's GitHub Actions runners?
139139

140140
We provide detailed usage analytics for GitHub Actions inside of your Organization Usage page. You can track minutes used, job durations, and other metrics across your entire organization.
141+
142+
### Can I use custom runner images with pre-installed software?
143+
144+
Yes, custom runner AMIs with pre-installed software are available on the Business plan. This is useful if you need specific tools, dependencies, or configurations that aren't included in our standard runner images.
145+
146+
With a custom runner AMI, we maintain a separate image specifically for your organization with your required software pre-installed. This can significantly reduce workflow execution time for dependencies that take time to install.
147+
148+
To request a custom runner AMI, please [contact our team](mailto:[email protected]) with details about your requirements.

content/github-actions/overview.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ We track builds by the second and only bill for whole minutes used at the end of
5050

5151
We can run our optimized runners in our cloud or your AWS account for additional security and compliance. We also support dedicated infrastructure and VPC peering options for something more custom to your needs.
5252

53+
### Custom runner images
54+
55+
For Business plan customers, we can create custom runner AMIs with pre-installed software tailored to your specific requirements. This is useful if you need specific tools, dependencies, or configurations that aren't included in our standard runner images. Contact us at [[email protected]](mailto:[email protected]) to discuss your needs.
56+
5357
### Integrates with Docker image builds
5458

5559
If you use Depot for faster Docker image builds via our [remote container builds](/docs/container-builds/overview), your BuildKit builder runs right next to your managed GitHub Action runner, allowing for faster CI builds by mimizing network latency and data transfer.

content/github-actions/runner-types.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The following labels are available:
105105

106106
## macOS runners
107107

108-
macOS runners use instances with M2 chips running macOS 14 or macOS 15. Their EBS volume is provisioned with 8000 IOPS and 1000 MB/s throughput. Like the Linux runners, the macOS runners also have a disk accelerator.
108+
macOS runners use instances with M2 chips running macOS 14 or macOS 15. Their EBS volume is provisioned with 12000 IOPS and 1000 MB/s throughput. Like the Linux runners, the macOS runners also have a disk accelerator.
109109

110110
The following labels are available:
111111

@@ -137,3 +137,13 @@ If you'd like to see what tools and software are installed in each runner image,
137137
- [`depot-windows-2022`](https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md)
138138

139139
_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._
140+
141+
## Custom runner images
142+
143+
If you need specific software pre-installed that isn't included in our standard runner images, custom runner AMIs are available on the Business plan. This is particularly useful for:
144+
145+
- Large dependencies that take significant time to install
146+
- Proprietary software or custom configurations
147+
- Corporate security or compliance tools
148+
149+
Contact us at [[email protected]](mailto:[email protected]) to discuss custom runner image requirements.

content/registry/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The Depot Registry supports authentication using various types of Depot tokens.
3939
- **Project tokens** - Full push and pull permissions for the specific project they're associated with
4040
- **Organization tokens** - Full push and pull permissions for any project within the organization
4141
- **Trust relationship tokens** - Full push and pull permissions for the project when issued via OIDC trust relationships
42-
- **Pull tokens** - Read-only access for pulling images only (generated via `depot pull-token`)
42+
- **Pull tokens** - Read-only access for pulling images only, valid for 1 hour (generated via `depot pull-token`)
4343

4444
### Authentication for `docker` CLI
4545

0 commit comments

Comments
 (0)