Merge pull request #394 from crazy-max/summary-without-upload

github(summary): build record upload optional

__tests__/github.test.itg.ts

@@ -248,6 +248,52 @@ maybe('writeBuildSummary', () => {
       }
     });
   });
+
+  it('without build record', async () => {
+    const startedTime = new Date();
+    const buildx = new Buildx();
+    const build = new Build({buildx: buildx});
+
+    fs.mkdirSync(tmpDir, {recursive: true});
+    await expect(
+      (async () => {
+        // prettier-ignore
+        const buildCmd = await buildx.getCommand([
+          '--builder', process.env.CTN_BUILDER_NAME ?? 'default',
+          'build',
+          '-f', path.join(fixturesDir, 'hello.Dockerfile'),
+          fixturesDir,
+          '--metadata-file', build.getMetadataFilePath()
+        ]);
+        await Exec.exec(buildCmd.command, buildCmd.args);
+      })()
+    ).resolves.not.toThrow();
+
+    const refs = Buildx.refs({
+      dir: Buildx.refsDir,
+      builderName: process.env.CTN_BUILDER_NAME ?? 'default',
+      since: startedTime
+    });
+    expect(refs).toBeDefined();
+    expect(Object.keys(refs).length).toBeGreaterThan(0);
+
+    const history = new History({buildx: buildx});
+    const exportRes = await history.export({
+      refs: [Object.keys(refs)[0] ?? '']
+    });
+    expect(exportRes).toBeDefined();
+    expect(exportRes?.dockerbuildFilename).toBeDefined();
+    expect(exportRes?.dockerbuildSize).toBeDefined();
+    expect(exportRes?.summaries).toBeDefined();
+
+    await GitHub.writeBuildSummary({
+      exportRes: exportRes,
+      inputs: {
+        context: fixturesDir,
+        file: path.join(fixturesDir, 'hello.Dockerfile')
+      }
+    });
+  });
 });
 
 maybe('annotateBuildWarnings', () => {

src/github.ts

@@ -233,30 +233,39 @@ export class GitHub {
 
     const refsSize = Object.keys(opts.exportRes.refs).length;
 
-    // we just need the last two parts of the URL as they are always relative
-    // to the workflow run URL otherwise URL could be broken if GitHub
-    // repository name is part of a secret value used in the workflow. e.g.:
-    //  artifact: https://github.com/docker/actions-toolkit/actions/runs/9552208295/artifacts/1609622746
-    //  workflow: https://github.com/docker/actions-toolkit/actions/runs/9552208295
-    // https://github.com/docker/actions-toolkit/issues/367
-    const artifactRelativeURL = `./${GitHub.runId}/${opts.uploadRes.url.split('/').slice(-2).join('/')}`;
-
-    // prettier-ignore
-    const sum = core.summary
-      .addHeading('Docker Build summary', 2)
-      .addRaw(`<p>`)
+    const sum = core.summary.addHeading('Docker Build summary', 2);
+
+    if (opts.uploadRes) {
+      // we just need the last two parts of the URL as they are always relative
+      // to the workflow run URL otherwise URL could be broken if GitHub
+      // repository name is part of a secret value used in the workflow. e.g.:
+      //  artifact: https://github.com/docker/actions-toolkit/actions/runs/9552208295/artifacts/1609622746
+      //  workflow: https://github.com/docker/actions-toolkit/actions/runs/9552208295
+      // https://github.com/docker/actions-toolkit/issues/367
+      const artifactRelativeURL = `./${GitHub.runId}/${opts.uploadRes.url.split('/').slice(-2).join('/')}`;
+
+      // prettier-ignore
+      sum.addRaw(`<p>`)
         .addRaw(`For a detailed look at the build, download the following build record archive and import it into Docker Desktop's Builds view. `)
         .addBreak()
         .addRaw(`Build records include details such as timing, dependencies, results, logs, traces, and other information about a build. `)
         .addRaw(addLink('Learn more', 'https://www.docker.com/blog/new-beta-feature-deep-dive-into-github-actions-docker-builds-with-docker-desktop/?utm_source=github&utm_medium=actions'))
       .addRaw('</p>')
       .addRaw(`<p>`)
         .addRaw(`:arrow_down: ${addLink(`<strong>${Util.stringToUnicodeEntities(opts.uploadRes.filename)}</strong>`, artifactRelativeURL)} (${Util.formatFileSize(opts.uploadRes.size)} - includes <strong>${refsSize} build record${refsSize > 1 ? 's' : ''}</strong>)`)
-      .addRaw(`</p>`)
-      .addRaw(`<p>`)
-        .addRaw(`Find this useful? `)
-        .addRaw(addLink('Let us know', 'https://docs.docker.com/feedback/gha-build-summary'))
-      .addRaw('</p>');
+      .addRaw(`</p>`);
+    } else {
+      // prettier-ignore
+      sum.addRaw(`<p>`)
+        .addRaw(`The following table provides a brief summary of your build.`)
+        .addBreak()
+        .addRaw(`For a detailed look at the build, including timing, dependencies, results, logs, traces, and other information, consider enabling the export of the build record so you can import it into Docker Desktop's Builds view. `)
+        .addRaw(addLink('Learn more', 'https://www.docker.com/blog/new-beta-feature-deep-dive-into-github-actions-docker-builds-with-docker-desktop/?utm_source=github&utm_medium=actions'))
+      .addRaw(`</p>`);
+    }
+
+    // Feedback survey
+    sum.addRaw(`<p>`).addRaw(`Find this useful? `).addRaw(addLink('Let us know', 'https://docs.docker.com/feedback/gha-build-summary')).addRaw('</p>');
 
     // Preview
     sum.addRaw('<p>');

src/types/github.ts

@@ -53,7 +53,7 @@ export interface UploadArtifactResponse {
 
 export interface BuildSummaryOpts {
   exportRes: ExportRecordResponse;
-  uploadRes: UploadArtifactResponse;
+  uploadRes?: UploadArtifactResponse;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   inputs?: any;
   bakeDefinition?: BakeDefinition;