Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GHA Docs #93

Merged
merged 7 commits into from
Nov 20, 2024
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
10 changes: 5 additions & 5 deletions content/github-actions/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: Faster GitHub Actions Runners
ogTitle: Overview of Depot managed GitHub Action Runners
description: Overview of Depot managed GitHub Action Runners with 30% faster compute, 10x faster caching, and half the cost of GitHub hosted runners per minute.
ogTitle: Overview of Depot-managed GitHub Action Runners
description: Overview of Depot-managed GitHub Action Runners with 30% faster compute, 10x faster caching, and half the cost of GitHub hosted runners per minute.
---

Our fully-managed GitHub Actions Runners are a simple drop-in replacement for your existing runners in any GitHub Action jobs. Our runners have 30% faster compute, 10x faster caching and are half the cost of GitHub hosted runners.

Here are a few technical and implementation details that are relevant for Depot-managed GitHub Actions runners:

- **Single tenant**: Runners are single tenant, we run your job and then kill the machine, it's never reused
- **Single tenant**: Runners are single tenant. We run your job and then kill the machine - it's never reused
- **30% faster compute**: For Intel runners, we launched with 4th Gen AMD EPYC Genoa CPUs and for Arm runners, we launched with AWS Graviton2 CPUs
- **10x faster cache**: Runners automatically integrate with our distributed cache architecture for upload and download speeds up to 1000 MiB/s on 12.5 Gbps of network throughput — no 10GB cache limit either
- **Per second billing**: We track builds by the second and only bill for whole minutes used at the end of the month and don't enforce a one minute minimum
- **Per second billing**: We track builds by the second and only bill for whole minutes used at the end of the month - and we don't enforce a one minute minimum
- **No limits**: No concurrency limits, no cache size limits, and no network limits
- **Self-hostable**: We can run our optimized runners in our cloud or your AWS account for additional security and compliance

In addition, 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.

## Pricing

Depot managed GitHub Action Runners are available on [all of our pricing plans](/pricing). Each plan includes a bucket of both of Docker build minutes and GitHub Actions minutes. Business plan customers can [contact us](mailto:[email protected]) for custom plans.
Depot-managed GitHub Action Runners are available on [all of our pricing plans](/pricing). Each plan includes a bucket of both Docker build minutes and GitHub Actions minutes. Business plan customers can [contact us](mailto:[email protected]) for custom plans.

| | Developer | Startup |
| ------------------------------- | :-------- | :--------------------------- |
Expand Down
14 changes: 7 additions & 7 deletions content/github-actions/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Below is a quickstart guide for connecting your Depot organization to GitHub and

If you have not already created an Organization, you will need to create one before proceeding. Organizations are the top-level entity in Depot. They typically represent a single company or team. Billing details are attached to an organization.

1. Login to your Depot account to get to your [list of organizations](/orgs)
1. Log in to your Depot account to get to your [list of organizations](/orgs)
2. Click on the `Create Organization` button
3. Enter an organization name
4. Click `Create organization`
Expand All @@ -33,7 +33,11 @@ If you're going to use Depot runners with public repositories, you will need to

## Configure your GitHub Actions workflow

Once Depot is connected to your GitHub organization and the application is approved, you can configure your GitHub Actions to use the runners by specifying the `runs-on` key in your workflow file.
### Depot-supported labels

Depot supports a variety of different runner types and sizes depending on your CI job needs, including Intel and Arm runners with up to 64 CPUs. See the [runner type docs](/docs/github-actions/runner-types) for a full list of available labels.

Once Depot is connected to your GitHub organization and the application is approved, you can configure your GitHub Actions to use your chosen runners by specifying the runner label in your `.github/workflows/*.yaml` file.

```diff
jobs:
Expand All @@ -45,10 +49,6 @@ jobs:
...
```

### Depot supported labels

Depot supports a variety of different runner types and sizes depending on your CI job needs, including Intel and Arm runners with up to 64 CPUs, and I/O-optimized runners with local NVMe disks. See the [runner type docs](/docs/github-actions/runner-types) for a full list of available labels.

## View GitHub Actions jobs

After configuring your GitHub Actions workflow to use Depot runners, you can view the jobs that have run on Depot runners in your organization's `GitHub Actions` tab.
Expand All @@ -57,6 +57,6 @@ After configuring your GitHub Actions workflow to use Depot runners, you can vie

## View GitHub Actions usage

Once you've started running GitHub Actions jobs on Depot runners, you can view the usage information in your organization's `Usage` tab. This includes the number of jobs, total job time, success and errors, build time, and cache storage used.
Once you've started running GitHub Actions jobs on Depot runners, you can view the usage information in your organization's `Usage` tab. This includes the number of jobs, total job time, successes and errors, build time, and cache storage used.

![View GitHub Actions usage](/images/docs/github-actions-usage.png)
19 changes: 12 additions & 7 deletions content/github-actions/runner-types.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: GitHub Actions Runner Types
ogTitle: Types of Depot managed GitHub Action Runners
ogTitle: Types of Depot-managed GitHub Action Runners
description: Depot offers several different types of GitHub Actions runners, depending on your CI job needs.
---

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 `runs-on` key in your GitHub Actions workflow file:
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:

```yaml
jobs:
Expand All @@ -16,7 +16,7 @@ jobs:

**In-memory Disk Accelerator**:

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.
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.

## Intel runners

Expand Down Expand Up @@ -52,7 +52,9 @@ The following labels are available:

## Ubuntu 24.04 runners

These runners use the same instances as the Ubuntu 22.04 runners. The following labels are available:
These runners use the same instances as the Ubuntu 22.04 runners.

The following labels are available:

| Label | CPUs | Memory | Disk size | Disk accelerator size | Per-minute price | Minutes multiplier |
| :----------------------------- | :--- | :----- | :-------- | :-------------------- | :--------------- | :----------------- |
Expand All @@ -79,7 +81,7 @@ macOS runners use instances with M2 chips running macOS 14. Their EBS volume is

**Note**: These runners are only available on the [Startup plan](/pricing) during beta.

The following label is available:
The following labels are available:

| Label | CPUs | Memory | Disk size | Per-minute price |
| :------------------- | :--- | :----- | :-------- | :--------------- |
Expand All @@ -88,6 +90,9 @@ The following label is available:

## Billing

Note that on your Billing summary, costs are broken down by `Billed minutes` and `Elapsed minutes`. `Elapsed minutes` is the wall time spent executing your Jobs, `Billed minutes` multiples the `Minutes multiplier` (from the table above) to the Elapsed minutes.
Note that on your Billing summary, costs are broken down by `Billed minutes` and `Elapsed minutes`. Here are several things to know about the difference:

Therefore, you will burn `Billed minutes` faster based on the size of the `Minutes multiplier`. Finally, what you pay is the total `Billed minutes` minus the included minutes of your Plan.
- `Elapsed minutes` is the clock time spent executing your jobs.
- `Billed minutes` multiples the `Minutes multiplier` (from the table above) by the `Elapsed minutes`.
- The rate at which `Billed minutes` accumulates is based on the size of the `Minutes multiplier`.
- What you pay is the total `Billed minutes` minus the included minutes of your plan.