Merge pull request #1160 from crazy-max/check-summary-support

move summary support check right after build

.github/workflows/ci.yml

@@ -1345,7 +1345,7 @@ jobs:
         run: |
           docker image inspect localhost:5000/name/app:latest
 
-  disable-summary:
+  summary-disable:
     runs-on: ubuntu-latest
     steps:
       -
@@ -1368,6 +1368,27 @@ jobs:
         env:
           DOCKER_BUILD_NO_SUMMARY: true
 
+  summary-not-supported:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+        with:
+          path: action
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          version: v0.12.1
+          driver-opts: |
+            image=${{ inputs.buildkit-image || env.BUILDKIT_IMAGE }}
+      -
+        name: Build
+        uses: ./action
+        with:
+          file: ./test/Dockerfile
+
   export-retention-days:
     runs-on: ubuntu-latest
     strategy:

package.json

@@ -27,7 +27,7 @@
   "packageManager": "yarn@3.6.3",
   "dependencies": {
     "@actions/core": "^1.10.1",
-    "@docker/actions-toolkit": "0.29.0",
+    "@docker/actions-toolkit": "0.30.0",
     "handlebars": "^4.7.7"
   },
   "devDependencies": {

src/main.ts

@@ -13,6 +13,7 @@ import {GitHub} from '@docker/actions-toolkit/lib/github';
 import {Toolkit} from '@docker/actions-toolkit/lib/toolkit';
 import {Util} from '@docker/actions-toolkit/lib/util';
 
+import {BuilderInfo} from '@docker/actions-toolkit/lib/types/buildx/builder';
 import {ConfigFile} from '@docker/actions-toolkit/lib/types/docker/docker';
 
 import * as context from './context';
@@ -80,10 +81,10 @@ actionsToolkit.run(
       await toolkit.buildx.printVersion();
     });
 
+    let builder: BuilderInfo;
     await core.group(`Builder info`, async () => {
-      const builder = await toolkit.builder.inspect(inputs.builder);
+      builder = await toolkit.builder.inspect(inputs.builder);
       core.info(JSON.stringify(builder, null, 2));
-      stateHelper.setBuilder(builder);
     });
 
     const args: string[] = await context.getArgs(inputs, toolkit);
@@ -105,7 +106,6 @@ actionsToolkit.run(
     const imageID = toolkit.buildxBuild.resolveImageID();
     const metadata = toolkit.buildxBuild.resolveMetadata();
     const digest = toolkit.buildxBuild.resolveDigest();
-
     if (imageID) {
       await core.group(`ImageID`, async () => {
         core.info(imageID);
@@ -125,36 +125,48 @@ actionsToolkit.run(
         core.setOutput('metadata', metadatadt);
       });
     }
+
+    let ref: string;
     await core.group(`Reference`, async () => {
-      const ref = await buildRef(toolkit, startedTime, inputs.builder);
+      ref = await buildRef(toolkit, startedTime, inputs.builder);
       if (ref) {
         core.info(ref);
         stateHelper.setBuildRef(ref);
       } else {
-        core.warning('No build ref found');
+        core.info('No build reference found');
       }
     });
+
+    await core.group(`Check build summary support`, async () => {
+      if (process.env.DOCKER_BUILD_NO_SUMMARY && Util.parseBool(process.env.DOCKER_BUILD_NO_SUMMARY)) {
+        core.info('Build summary disabled');
+      } else if (GitHub.isGHES) {
+        core.warning('Build summary is not yet supported on GHES');
+      } else if (!(await toolkit.buildx.versionSatisfies('>=0.13.0'))) {
+        core.warning('Build summary requires Buildx >= 0.13.0');
+      } else if (builder && builder.driver === 'cloud') {
+        core.warning('Build summary is not yet supported with Docker Build Cloud');
+      } else if (!ref) {
+        core.warning('Build summary requires a build reference');
+      } else {
+        core.info('Build summary supported!');
+        stateHelper.setSummarySupported();
+      }
+    });
+
     if (err) {
       throw err;
     }
   },
   // post
   async () => {
-    if (stateHelper.buildRef.length > 0) {
+    if (stateHelper.isSummarySupported) {
       await core.group(`Generating build summary`, async () => {
-        if (process.env.DOCKER_BUILD_NO_SUMMARY && Util.parseBool(process.env.DOCKER_BUILD_NO_SUMMARY)) {
-          core.info('Summary disabled');
-          return;
-        }
-        if (stateHelper.builder && stateHelper.builder.driver === 'cloud') {
-          core.info('Summary is not yet supported with Docker Build Cloud');
-          return;
-        }
         try {
           const exportRetentionDays = buildExportRetentionDays();
           const buildxHistory = new BuildxHistory();
           const exportRes = await buildxHistory.export({
-            refs: [stateHelper.buildRef]
+            refs: stateHelper.buildRef ? [stateHelper.buildRef] : []
           });
           core.info(`Build record exported to ${exportRes.dockerbuildFilename} (${Util.formatFileSize(exportRes.dockerbuildSize)})`);
           const uploadRes = await GitHub.uploadArtifact({

src/state-helper.ts

@@ -1,13 +1,11 @@
 import * as core from '@actions/core';
 
-import {BuilderInfo} from '@docker/actions-toolkit/lib/types/buildx/builder';
-
 import {Inputs, sanitizeInputs} from './context';
 
 export const tmpDir = process.env['STATE_tmpDir'] || '';
 export const inputs = process.env['STATE_inputs'] ? JSON.parse(process.env['STATE_inputs']) : undefined;
-export const builder = process.env['STATE_builder'] ? <BuilderInfo>JSON.parse(process.env['STATE_builder']) : undefined;
 export const buildRef = process.env['STATE_buildRef'] || '';
+export const isSummarySupported = !!process.env['STATE_isSummarySupported'];
 
 export function setTmpDir(tmpDir: string) {
   core.saveState('tmpDir', tmpDir);
@@ -17,10 +15,10 @@ export function setInputs(inputs: Inputs) {
   core.saveState('inputs', JSON.stringify(sanitizeInputs(inputs)));
 }
 
-export function setBuilder(builder: BuilderInfo) {
-  core.saveState('builder', JSON.stringify(builder));
-}
-
 export function setBuildRef(buildRef: string) {
   core.saveState('buildRef', buildRef);
 }
+
+export function setSummarySupported() {
+  core.saveState('isSummarySupported', 'true');
+}

yarn.lock

@@ -1055,9 +1055,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@docker/actions-toolkit@npm:0.29.0":
-  version: 0.29.0
-  resolution: "@docker/actions-toolkit@npm:0.29.0"
+"@docker/actions-toolkit@npm:0.30.0":
+  version: 0.30.0
+  resolution: "@docker/actions-toolkit@npm:0.30.0"
   dependencies:
     "@actions/artifact": ^2.1.7
     "@actions/cache": ^3.2.4
@@ -1080,7 +1080,7 @@ __metadata:
     semver: ^7.6.2
     tar-stream: ^3.1.7
     tmp: ^0.2.3
-  checksum: c5685a5de22103d4d2cd978eaecd042be5fd8f5e166b11a1ff9f5a852b65b67969c237b43b3b742bfe85457b03ee60088e58ebc3cfa8b33b7df659e916fd4484
+  checksum: 0e5ea396c93558b4f9841485c57094a707a98cbbc4ade0de119fdf30dc4c3c7fbb0a5ed86d187f89d78db03f66ea5c6903f241d5ca87c9a0f780ae868f866310
   languageName: node
   linkType: hard
 
@@ -3150,7 +3150,7 @@ __metadata:
   resolution: "docker-build-push@workspace:."
   dependencies:
     "@actions/core": ^1.10.1
-    "@docker/actions-toolkit": 0.29.0
+    "@docker/actions-toolkit": 0.30.0
     "@types/node": ^20.12.12
     "@typescript-eslint/eslint-plugin": ^7.9.0
     "@typescript-eslint/parser": ^7.9.0