Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
  • Loading branch information
gtardif committed May 31, 2024
1 parent 0b99544 commit 5beda85
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,12 @@
Github Action to start Docker Desktop.

This github action is [experimental](https://docs.docker.com/release-lifecycle/#experimental).
It currently supports starting Docker Desktop on large-runner "linux" nodes in Github Actions.
It currently supports starting Docker Desktop on "linux" nodes (ubuntu-latest) in Github Actions.

**Important**: it seems that since mid September 2023, the action inconsistently fails on macOs runner. We have updated the action to use linux runners. However, since virtualisation is required for Docker Desktop to start, you must be sure that the runner as it enabled. Large-runners [have it from February 2023]([url](https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/)).
**Important**: since mid September 2023, the action inconsistently fails on macOs runner. We have updated the action to use linux runners.

Note that the usage of Docker Desktop is subject to [Docker Desktop license agreement](https://docs.docker.com/subscription/desktop-license/).

In your GitHub Action workflow, you must use a [GitHub large-runner]([url](https://docs.github.com/en/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners)) with virtualization enabled, and then you can add a step:

```
jobs:
test-docker-desktop:
name: Test Docker Desktop installation and start
runs-on: large-ubuntu
steps:
- id: start_desktop
uses: docker/desktop-action/start@v0.3.0
```

After this step executes, Docker Desktop is ready and available, the docker CLI can be executed in subsequent "run" steps

By default, the action downloads the last version of Docker Desktop. But you can specify another one by providing the build URL from where the action can download the specific version:
Expand All @@ -32,7 +20,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ large-ubuntu ]
os: [ ubuntu-latest ]
build-url: [ "latest", "https://desktop.docker.com/linux/main/amd64/122432/docker-desktop-4.24.0-amd64.deb" ]
steps:
Expand Down

0 comments on commit 5beda85

Please sign in to comment.