Merge pull request #26 from crazy-max/colima-start-args

docs: define custom "colima start" arguments

.github/workflows/ci.yml

@@ -74,6 +74,35 @@ jobs:
         if: always()
         uses: crazy-max/ghaction-dump-context@v2
 
+  daemon-config:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Set up Docker
+        uses: ./
+        with:
+          daemon-config: |
+            {
+              "debug": true,
+              "features": {
+                "containerd-snapshotter": true
+              }
+            }
+      -
+        name: Dump context
+        if: always()
+        uses: crazy-max/ghaction-dump-context@v2
+
   context:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -102,6 +131,18 @@ jobs:
         if: always()
         uses: crazy-max/ghaction-dump-context@v2
 
+  colima-start-args:
+    runs-on: macos-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Set up Docker
+        uses: ./
+        env:
+          COLIMA_START_ARGS: --cpu 4 --memory 8 --disk 32 --dns 1.1.1.1 --dns 8.8.8.8 --dns-host example.com=1.2.3.4
+
   build-linux:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -14,6 +14,9 @@ Works on Linux, macOS and Windows.
 ___
 
 * [Usage](#usage)
+  * [Quick start](#quick-start)
+  * [Daemon configuration](#daemon-configuration)
+  * [Define custom `colima start` arguments (macOS)](#define-custom-colima-start-arguments-macos)
 * [Customizing](#customizing)
   * [inputs](#inputs)
 * [Notes](#notes)
@@ -22,6 +25,8 @@ ___
 
 ## Usage
 
+### Quick start
+
 ```yaml
 name: ci
 
@@ -37,6 +42,58 @@ jobs:
         uses: crazy-max/ghaction-setup-docker@v1
 ```
 
+### Daemon configuration
+
+You can [configure the Docker daemon](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file)
+using the `daemon-config` input. In the following example, we configure the
+Docker daemon to enable debug and the [containerd image store](https://docs.docker.com/storage/containerd/)
+feature:
+
+```yaml
+name: ci
+
+on:
+  push:
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Set up Docker
+        uses: crazy-max/ghaction-setup-docker@v1
+        with:
+          daemon-config: |
+            {
+              "debug": true,
+              "features": {
+                "containerd-snapshotter": true
+              }
+            }
+```
+
+### Define custom `colima start` arguments (macOS)
+
+You can define custom [`colima start` arguments](https://github.com/abiosoft/colima#customizing-the-vm)
+using the `COLIMA_START_ARGS` environment variable to customize the VM:
+
+```yaml
+name: ci
+
+on:
+  push:
+
+jobs:
+  docker:
+    runs-on: macos-latest
+    steps:
+      -
+        name: Set up Docker
+        uses: crazy-max/ghaction-setup-docker@v1
+        env:
+          COLIMA_START_ARGS: --cpu 4 --memory 8 --disk 32
+```
+
 ## Customizing
 
 ### inputs
@@ -44,9 +101,10 @@ jobs:
 Following inputs can be used as `step.with` keys
 
 | Name            | Type   | Default               | Description                                                                                                                 |
-|-----------|--------|-----------------------|---------------------------------------------------------------------------------------------------|
+|-----------------|--------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|
 | `version`       | String | `latest`              | Docker CE version (e.g., `v23.0.1`).                                                                                        |
 | `channel`       | String | `stable`              | Docker CE [channel](https://download.docker.com/linux/static/) (e.g, `stable`, `edge` or `test`).                           |
+| `daemon-config` | String |                       | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
 | `context`       | String | `setup-docker-action` | Docker context name.                                                                                                        |
 
 ## Notes

__tests__/context.test.ts

@@ -23,6 +23,7 @@ describe('getInputs', () => {
         version: 'v23.0.1',
         channel: '',
         context: '',
+        daemonConfig: '',
       } as context.Inputs
     ],
     [
@@ -31,11 +32,13 @@ describe('getInputs', () => {
         ['version', 'v23.0.0-rc.4'],
         ['channel', 'test'],
         ['context', 'foo'],
+        ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
       ]),
       {
         version: 'v23.0.0-rc.4',
         channel: 'test',
         context: 'foo',
+        daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
       } as context.Inputs
     ],
     [
@@ -45,6 +48,7 @@ describe('getInputs', () => {
         version: 'latest',
         channel: '',
         context: '',
+        daemonConfig: '',
       } as context.Inputs
     ]
   ])(

action.yml

@@ -14,6 +14,9 @@ inputs:
   channel:
     description: 'Docker CE channel. (e.g, stable, edge or test)'
     required: false
+  daemon-config:
+    description: 'Docker daemon JSON configuration'
+    required: false
   context:
     description: 'Docker context name. (default setup-docker-action)'
     required: false

dist/licenses.txt

@@ -965,6 +965,31 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
+js-yaml
+MIT
+(The MIT License)
+
+Copyright (C) 2011-2015 by Vitaly Puzrin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
 jwt-decode
 MIT
 The MIT License (MIT)

package.json

@@ -22,7 +22,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@docker/actions-toolkit": "^0.10.0",
+    "@docker/actions-toolkit": "^0.12.0-rc.1",
     "uuid": "^9.0.0"
   },
   "devDependencies": {

src/context.ts

@@ -3,6 +3,7 @@ import * as core from '@actions/core';
 export interface Inputs {
   version: string;
   channel: string;
+  daemonConfig?: string;
   context: string;
 }
 
@@ -10,6 +11,7 @@ export function getInputs(): Inputs {
   return {
     version: core.getInput('version') || 'latest',
     channel: core.getInput('channel'),
+    daemonConfig: core.getInput('daemon-config'),
     context: core.getInput('context')
   };
 }

src/main.ts

@@ -23,7 +23,8 @@ actionsToolkit.run(
       runDir: runDir,
       version: input.version,
       channel: input.channel || 'stable',
-      contextName: input.context || 'setup-docker-action'
+      contextName: input.context || 'setup-docker-action',
+      daemonConfig: input.daemonConfig
     });
     let toolDir;
     if (!(await Docker.isAvailable()) || input.version) {

yarn.lock

@@ -480,10 +480,10 @@
   dependencies:
     "@cspotcode/source-map-consumer" "0.8.0"
 
-"@docker/actions-toolkit@^0.10.0":
+"@docker/actions-toolkit@^0.12.0-rc.1":
-  version "0.10.0"
+  version "0.12.0-rc.1"
-  resolved "https://registry.yarnpkg.com/@docker/actions-toolkit/-/actions-toolkit-0.10.0.tgz#5a2769ae48c93c689db2b9c665cd9fb80123c419"
+  resolved "https://registry.yarnpkg.com/@docker/actions-toolkit/-/actions-toolkit-0.12.0-rc.1.tgz#a6a163770c776db4c32106e497d752b91378cff1"
-  integrity sha512-87ivF6QROwDTeWCfIEK+JLkp5H0f/HGuDF4/VlulvZQFARiv344Xi5MBFTAU4Zd3kxKYEE2RwTw01aYDLr08Nw==
+  integrity sha512-/p/zoVOh6UePqtRu49c/bI5oxOfs2GvPL9s8DL5y02swkx6kETEpwyMRbYTalDVlvsTcDJwPF8UbLZRheuaxFA==
   dependencies:
     "@actions/cache" "^3.2.2"
     "@actions/core" "^1.10.0"
@@ -494,8 +494,9 @@
     "@actions/tool-cache" "^2.0.1"
     "@octokit/plugin-rest-endpoint-methods" "^7.2.3"
     async-retry "^1.3.3"
-    csv-parse "^5.4.0"
+    csv-parse "^5.5.0"
     handlebars "^4.7.8"
+    js-yaml "^4.1.0"
     jwt-decode "^3.1.2"
     semver "^7.5.4"
     tmp "^0.2.1"
@@ -1576,10 +1577,10 @@ cssstyle@^2.3.0:
   dependencies:
     cssom "~0.3.6"
 
-csv-parse@^5.4.0:
+csv-parse@^5.5.0:
-  version "5.4.0"
+  version "5.5.0"
-  resolved "https://registry.yarnpkg.com/csv-parse/-/csv-parse-5.4.0.tgz#6793210a4a49a9a74b3fde3f9d00f3f52044fd89"
+  resolved "https://registry.yarnpkg.com/csv-parse/-/csv-parse-5.5.0.tgz#2313421e69b650dae32a79ac884b20b21ca1d9da"
-  integrity sha512-JiQosUWiOFgp4hQn0an+SBoV9IKdqzhROM0iiN4LB7UpfJBlsSJlWl9nq4zGgxgMAzHJ6V4t29VAVD+3+2NJAg==
+  integrity sha512-RxruSK3M4XgzcD7Trm2wEN+SJ26ChIb903+IWxNOcB5q4jT2Cs+hFr6QP39J05EohshRFEvyzEBoZ/466S2sbw==
 
 data-urls@^2.0.0:
   version "2.0.0"