Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
benja-M-1 authored Nov 10, 2023
1 parent bf3d9d0 commit 194a2b2
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,32 @@ Note that the usage of Docker Desktop is subject to [Docker Desktop license agre
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:

```
steps:
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.2.0
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:

```
jobs:
test-docker-desktop:
name: Test Docker Desktop installation and start
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ large-ubuntu ]
build-url: [ "latest", "https://desktop.docker.com/linux/main/amd64/122432/docker-desktop-4.24.0-amd64.deb" ]
steps:
- name: Start Desktop
uses: ./start
with:
docker-desktop-build-url: ${{ matrix.build-url }}
```

0 comments on commit 194a2b2

Please sign in to comment.