Skip to content

Commit 45255e0

Browse files
docs: note about action usage
1 parent 81b4f9b commit 45255e0

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@
99
GitHub Action to set up (download and install) [Docker CE](https://docs.docker.com/engine/).
1010
Works on Linux, macOS and Windows.
1111

12+
> [!NOTE]
13+
> This action is useful if you want to pin against a specific Docker version or
14+
> set up a custom daemon configuration or if Docker is not available on your
15+
> runner. If you're using [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)
16+
> on Linux or Windows, Docker is already up and running, so it might not be
17+
> necessary to use this action.
18+
1219
> [!WARNING]
1320
> Does not work on macOS runners with ARM architecture (no nested virtualization):
1421
> * https://github.com/docker/actions-toolkit/issues/317

0 commit comments

Comments
 (0)