github: annotate build warnings

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>

.github/workflows/test.yml

@@ -15,7 +15,7 @@ on:
 
 env:
   NODE_VERSION: "20"
-  BUILDX_VERSION: "v0.15.0"
+  BUILDX_VERSION: "https://github.com/crazy-max/buildx.git#metadata-warnings"
 
 jobs:
   test:

__tests__/fixtures/lint.Dockerfile

@@ -0,0 +1,8 @@
+# syntax=docker/dockerfile-upstream:master
+frOM busybox as base
+cOpy lint.Dockerfile .
+
+from scratch
+COPy --from=base \
+  /lint.Dockerfile \
+  /

__tests__/github.test.itg.ts

@@ -194,3 +194,34 @@ maybe('writeBuildSummary', () => {
     });
   });
 });
+
+maybe('annotateBuildWarnings', () => {
+  it('annoate lint issues', async () => {
+    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, 'lint.Dockerfile'),
+          fixturesDir,
+          '--metadata-file', build.getMetadataFilePath()
+        ]);
+        await Exec.exec(buildCmd.command, buildCmd.args);
+      })()
+    ).resolves.not.toThrow();
+
+    const metadata = build.resolveMetadata();
+    expect(metadata).toBeDefined();
+    const buildRef = build.resolveRef(metadata);
+    expect(buildRef).toBeDefined();
+    const buildStatus = build.resolveStatus(metadata);
+    expect(buildStatus).toBeDefined();
+
+    await GitHub.annotateBuildWarnings(path.join(fixturesDir, 'lint.Dockerfile'), buildStatus ?? {});
+  });
+});

src/github.ts

@@ -35,6 +35,7 @@ import {jwtDecode, JwtPayload} from 'jwt-decode';
 
 import {Util} from './util';
 
+import {SolveStatus} from './types/buildkit/client';
 import {BuildSummaryOpts, GitHubActionsRuntimeToken, GitHubActionsRuntimeTokenAC, GitHubRepo, UploadArtifactOpts, UploadArtifactResponse} from './types/github';
 
 export interface GitHubOpts {
@@ -281,4 +282,14 @@ export class GitHub {
     core.info(`Writing summary`);
     await sum.addSeparator().write();
   }
+
+  public static async annotateBuildWarnings(source: string, st: SolveStatus): Promise<void> {
+    st.warnings?.forEach(warning => {
+      core.warning(warning.detail?.map(encoded => atob(encoded)).join(' ') || 'n/a', {
+        title: atob(warning.short) || 'Build warning',
+        file: source,
+        startLine: warning.range && warning.range.length > 0 ? warning.range[0]?.start.line : undefined
+      });
+    });
+  }
 }