Skip to content

Commit 7c90fc8

Browse files
kylegalbraithgithub-actions[bot]
authored andcommitted
Update docs content from https://github.com/depot/app
1 parent 80a8ccb commit 7c90fc8

5 files changed

Lines changed: 61 additions & 4 deletions

File tree

content/cli/installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Either install with [our installation script](https://depot.dev/install-cli.sh):
2525
curl -L https://depot.dev/install-cli.sh | sh
2626

2727
# Install a specific version
28-
curl -L https://depot.dev/install-cli.sh | sh -s 1.6.0
28+
curl -L https://depot.dev/install-cli.sh | sh -s x.y.z
2929
```
3030

3131
Or download the latest version from [GitHub releases](https://github.com/depot/cli/releases).

content/container-builds/reference/api-overview.mdx

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,13 +274,43 @@ const headers = {Authorization: `Bearer ${process.env.DEPOT_TOKEN}`}
274274
await depot.build.v1.BuildService.finishBuild({buildId: 'build-id', result: {error: 'error message'}}, {headers})
275275
```
276276

277+
#### List the steps for a build
278+
279+
To list the steps for a build, you need to pass the build ID, the project ID, the number of steps to page, and an optional page token returned from a previous API call.
280+
281+
```typescript
282+
const headers = {Authorization: `Bearer ${process.env.DEPOT_TOKEN}`}
283+
const result = await depot.build.v1.BuildService.getBuildSteps(
284+
{buildId: 'build-id', projectId: 'project-id', pageSize: 100, pageToken: 'page-token'},
285+
{headers},
286+
)
287+
```
288+
289+
#### Get the logs for a build step
290+
291+
To get the logs for a build step, you need to pass the build ID, the project ID, and the build step's digest. You can also pass the number of lines to page and an optional page token returned from a previous API call.
292+
293+
```typescript
294+
const headers = {Authorization: `Bearer ${process.env.DEPOT_TOKEN}`}
295+
const result = await depot.build.v1.BuildService.getBuildStepLogs(
296+
{
297+
buildId: 'build-id',
298+
projectId: 'project-id',
299+
buildStepDigest: 'step-digest',
300+
pageSize: 100,
301+
pageToken: 'page-token',
302+
},
303+
{headers},
304+
)
305+
```
306+
277307
### Registry Service
278308

279309
Docs: [`depot.build.v1.RegistryService`](https://buf.build/depot/api/docs/main:depot.build.v1#depot.build.v1.RegistryService)
280310

281311
The Registry service provides access to the underlying registry that stores the images built by Depot. You can use this service to list and delete images.
282312

283-
### List the images for a project
313+
#### List the images for a project
284314

285315
To list the images for a project, you need to pass the ID of the project you want to list the images for. When listing more than 100 images, you can use the `pageSize` and `pageToken` fields to paginate the results.
286316

@@ -298,7 +328,7 @@ console.log(result.nextPageToken)
298328

299329
The images returned will consist of an image tag, digest, a pushedAt timestamp, and the size of the image in bytes.
300330

301-
### Delete images
331+
#### Delete images
302332

303333
To delete images, you need to pass the ID of the project and the list of image tags you want to removed.
304334

content/github-actions/reference/dagger.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ on: push
3434

3535
jobs:
3636
build:
37-
runs-on: depot-ubuntu-22.04,dagger=0.15.2
37+
runs-on: depot-ubuntu-latest,dagger=0.18.4
3838
steps:
3939
- uses: actions/checkout@v4
4040
- run: dagger -m github.com/kpenfound/dagger-modules/golang@v0.2.0 call \
@@ -48,6 +48,21 @@ The Dagger CLI will be available and pre-authenticated with your Dagger Cloud to
4848
4949
With these steps, your workflow is now ready to run on Depot’s accelerated infrastructure using Dagger and GitHub Actions.
5050
51+
## How does it work?
52+
53+
Using Dagger engines via Depot GitHub Actions Runners allows you to execute your Dagger pipelines and functions inside of a dedicated VM with a persistent NVMe device for cache storage that lives next to the GitHub Actions runners without having to do any additional configuration outside of the above.
54+
55+
### Architecture
56+
57+
![Depot GitHub Actions Runners with Dagger architecture](/images/dagger-arch-diagram.png)
58+
59+
The general architecture allows for fast persistent cache for your Dagger projects automatically across builds. Here is the flow of information and what happens at each step when you specify `runs-on: depot-ubuntu-latest,dagger=<version>` in your GitHub Actions workflow:
60+
61+
1. The Depot control plane receives the request for your GitHub Actions job and takes note of your request for a Dagger engine as well. We launch the Dagger Engine VM at the specified version next to your GitHub Actions runner, attaching your cache volume from previous builds to that VM. We then tell the GitHub Actions runner to pre-configure the GitHub Actions environment, installing the specific `dagger` CLI version for you and point it at the Dagger Engine running next door, and automatically authenticate to your Dagger Cloud account for logs and telemetry.
62+
2. The GitHub Actions runner starts up and runs the job, which includes the Dagger CLI. The Dagger CLI is pre-configured to use the Dagger Engine running next door, the `dagger` step is thus kicked off on the separate Dagger Engine VM with it's persistent cache. The Dagger execution runs to completion and logs + telemetry are shipped to your Dagger Cloud account.
63+
3. The Dagger Engine VM is automatically shut down after the job completes, and the cache volume is detached from the VM and returned to Depot's control plane for future use.
64+
4. The GitHub Actions runner completes the job and returns the results to GitHub.
65+
5166
## Pricing
5267

5368
Dagger engines accessed via our GitHub Actions Runners are charged by the build minute at $0.04/minute, in addition to the GitHub Actions Runner build time.

content/github-actions/runner-types.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,14 @@ Note that on your Billing summary, costs are broken down by `Billed minutes` and
116116
- `Billed minutes` multiples the `Minutes multiplier` (from the table above) by the `Elapsed minutes`.
117117
- The rate at which `Billed minutes` accumulates is based on the size of the `Minutes multiplier`.
118118
- What you pay is the total `Billed minutes` minus the included minutes of your plan.
119+
120+
## What software and tools are included?
121+
122+
If you'd like to see what tools and software are installed in each runner image, please see the links to the `README` in GitHub's repository:
123+
124+
- [`depot-ubuntu-24.04`](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md) and `depot-ubuntu-latest`
125+
- [`depot-ubuntu-22.04`](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md)
126+
- [`depot-macos-14`](https://github.com/actions/runner-images/blob/main/images/macos/macos-14-Readme.md) and `depot-macos-latest`
127+
- [`depot-windows-2022`](https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md)
128+
129+
_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._

content/registry/overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ By default, builds saved in the Depot Registry persist for **7 days** from when
5050

5151
Possible values for the retention policy are:
5252

53+
- **1 day**
5354
- **7 days** (default)
5455
- **14 days**
5556
- **30 days**

0 commit comments

Comments
 (0)