Support to retain cache

Signed-off-by: Balaji Arun <[email protected]>

Author: ibalajiarun

README.md

@@ -100,6 +100,7 @@ The following inputs can be used as `step.with` keys:
 | `append`                     | YAML     |                    | [Append additional nodes](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder) to the builder                          |
 | `cache-binary`               | Bool     | `true`             | Cache buildx binary to GitHub Actions cache backend                                                                                                                          |
 | `cleanup`                    | Bool     | `true`             | Cleanup temp files and remove builder at the end of a job                                                                                                                    |
+| `name`                       | String   | Default Docker Context | Name of the builder to create or use. If a builder with this name already exists, it will be used instead of creating a new one.                                              |
 
 > [!IMPORTANT]
 > If you set the `buildkitd-flags` input, the default flags (`--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host`)

__tests__/context.test.ts

@@ -56,6 +56,7 @@ describe('getCreateArgs', () => {
         ['use', 'true'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -74,6 +75,7 @@ describe('getCreateArgs', () => {
         ['use', 'true'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -92,6 +94,7 @@ describe('getCreateArgs', () => {
         ['driver-opts', 'image=moby/buildkit:master\nnetwork=host'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -112,6 +115,7 @@ describe('getCreateArgs', () => {
         ['use', 'true'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -132,6 +136,7 @@ describe('getCreateArgs', () => {
         ['use', 'true'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -151,6 +156,7 @@ describe('getCreateArgs', () => {
         ['driver-opts', `"env.no_proxy=localhost,127.0.0.1,.mydomain"`],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false'],
       ]),
       [
         'create',
@@ -169,6 +175,7 @@ describe('getCreateArgs', () => {
         ['platforms', 'linux/amd64\n"linux/arm64,linux/arm/v7"'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false'],
       ]),
       [
         'create',
@@ -187,6 +194,7 @@ describe('getCreateArgs', () => {
         ['driver', 'unknown'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false'],
       ]),
       [
         'create',
@@ -203,6 +211,7 @@ describe('getCreateArgs', () => {
         ['buildkitd-config', path.join(fixturesDir, 'buildkitd.toml')],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false'],
       ]),
       [
         'create',
@@ -221,6 +230,7 @@ describe('getCreateArgs', () => {
         ['buildkitd-config-inline', 'debug = true'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false'],
       ]),
       [
         'create',
@@ -240,14 +250,53 @@ describe('getCreateArgs', () => {
         ['buildkitd-flags', '--allow-insecure-entitlement network.host'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false'],
       ]),
       [
         'create',
         '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
         '--driver', 'cloud',
         '--buildkitd-flags', '--allow-insecure-entitlement network.host',
       ]
-    ]
+    ],
+    [
+      11,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'true'],
+        ['cleanup', 'true'],
+        ['cache-binary', 'true'],
+        ['keep-state', 'false'],
+        ['name', 'test-builder-name'],
+      ]),
+      [
+        'create',
+        '--name', 'test-builder-name',
+        '--driver', 'docker-container',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--use'
+      ]
+    ],
+    [
+      12,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'true'],
+        ['cleanup', 'true'],
+        ['cache-binary', 'true'],
+        ['keep-state', 'true'],
+        ['name', 'test-builder-name'],
+      ]),
+      [
+        'create',
+        '--name', 'test-builder-name',
+        '--driver', 'docker-container',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--use',
+      ]
+    ],
   ])(
     '[%d] given buildx %s and %p as inputs, returns %p',
     async (num: number, buildxVersion: string, inputs: Map<string, string>, expected: Array<string>) => {
@@ -285,6 +334,7 @@ describe('getAppendArgs', () => {
         ['use', 'true'],
         ['cache-binary', 'true'],
         ['cleanup', 'true'],
+        ['keep-state', 'false']
       ]),
       {
         "name": "aws_graviton2",

action.yml

@@ -50,6 +50,12 @@ inputs:
   cleanup:
     description: 'Cleanup temp files and remove builder at the end of a job'
     default: 'true'
+  keep-state:
+    description: 'Keep BuildKit state on cleanup. This is only useful on persistent self-hosted runners.'
+    default: 'false'
+    required: false
+  name:
+    description: 'Builder name set when creating the builder. If not specified, one will be generated.'
     required: false
   # TODO: remove deprecated config and config-inline inputs
   config: