Skip to content

Commit 2dbe91d

Browse files
crazy-maxcrazy-max
authored
Merge pull request #1197 from crazy-max/build-checks
generate GitHub annotations for build checks
2 parents a8d3541 + 7de3854 commit 2dbe91d

File tree

6 files changed

+93
-5
lines changed

6 files changed

+93
-5
lines changed

‎.github/workflows/ci.yml

+48
Original file line numberDiff line numberDiff line change
@@ -1463,3 +1463,51 @@ jobs:
14631463
file: ./test/Dockerfile
14641464
env:
14651465
DOCKER_BUILD_RECORD_RETENTION_DAYS: ${{ matrix.days }}
1466+
1467+
checks:
1468+
runs-on: ubuntu-latest
1469+
strategy:
1470+
fail-fast: false
1471+
matrix:
1472+
buildx-version:
1473+
- latest
1474+
- v0.14.1
1475+
steps:
1476+
-
1477+
name: Checkout
1478+
uses: actions/checkout@v4
1479+
-
1480+
name: Set up Docker Buildx
1481+
uses: docker/setup-buildx-action@v3
1482+
with:
1483+
version: ${{ matrix.buildx-version }}
1484+
driver-opts: |
1485+
image=${{ inputs.buildkit-image || env.BUILDKIT_IMAGE }}
1486+
-
1487+
name: Build
1488+
uses: ./
1489+
with:
1490+
context: ./test
1491+
file: ./test/lint.Dockerfile
1492+
1493+
annotations-disabled:
1494+
runs-on: ubuntu-latest
1495+
steps:
1496+
-
1497+
name: Checkout
1498+
uses: actions/checkout@v4
1499+
-
1500+
name: Set up Docker Buildx
1501+
uses: docker/setup-buildx-action@v3
1502+
with:
1503+
version: ${{ inputs.buildx-version || env.BUILDX_VERSION }}
1504+
driver-opts: |
1505+
image=${{ inputs.buildkit-image || env.BUILDKIT_IMAGE }}
1506+
-
1507+
name: Build
1508+
uses: ./
1509+
with:
1510+
context: ./test
1511+
file: ./test/lint.Dockerfile
1512+
env:
1513+
DOCKER_BUILD_CHECKS_ANNOTATIONS: false

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ The following outputs are available:
258258

259259
| Name | Type | Default | Description |
260260
|--------------------------------------|--------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
261+
| `DOCKER_BUILD_CHECKS_ANNOTATIONS` | Bool | `true` | If `false`, GitHub annotations are not generated for [build checks](https://docs.docker.com/build/checks/) |
261262
| `DOCKER_BUILD_SUMMARY` | Bool | `true` | If `false`, [build summary](https://docs.docker.com/build/ci/github-actions/build-summary/) generation is disabled |
262263
| `DOCKER_BUILD_RECORD_UPLOAD` | Bool | `true` | If `false`, build record upload as [GitHub artifact](https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts) is disabled |
263264
| `DOCKER_BUILD_RECORD_RETENTION_DAYS` | Number | | Duration after which build record artifact will expire in days. Defaults to repository/org [retention settings](https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy) if unset or `0` |

‎dist/index.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/main.ts

+30-3
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,12 @@ actionsToolkit.run(
9797

9898
let err: Error | undefined;
9999
await Exec.getExecOutput(buildCmd.command, buildCmd.args, {
100-
ignoreReturnCode: true
100+
ignoreReturnCode: true,
101+
env: Object.assign({}, process.env, {
102+
BUILDX_METADATA_WARNINGS: 'true'
103+
}) as {
104+
[key: string]: string;
105+
}
101106
}).then(res => {
102107
if (res.stderr.length > 0 && res.exitCode != 0) {
103108
err = Error(`buildx failed with: ${res.stderr.match(/(.*)\s*$/)?.[0]?.trim() ?? 'unknown error'}`);
@@ -106,7 +111,7 @@ actionsToolkit.run(
106111

107112
const imageID = toolkit.buildxBuild.resolveImageID();
108113
const metadata = toolkit.buildxBuild.resolveMetadata();
109-
const digest = toolkit.buildxBuild.resolveDigest();
114+
const digest = toolkit.buildxBuild.resolveDigest(metadata);
110115
if (imageID) {
111116
await core.group(`ImageID`, async () => {
112117
core.info(imageID);
@@ -127,7 +132,7 @@ actionsToolkit.run(
127132
});
128133
}
129134

130-
let ref: string;
135+
let ref: string | undefined;
131136
await core.group(`Reference`, async () => {
132137
ref = await buildRef(toolkit, startedTime, inputs.builder);
133138
if (ref) {
@@ -138,6 +143,21 @@ actionsToolkit.run(
138143
}
139144
});
140145

146+
if (buildChecksAnnotationsEnabled()) {
147+
const warnings = toolkit.buildxBuild.resolveWarnings(metadata);
148+
if (ref && warnings && warnings.length > 0) {
149+
const annotations = await Buildx.convertWarningsToGitHubAnnotations(warnings, [ref]);
150+
core.debug(`annotations: ${JSON.stringify(annotations, null, 2)}`);
151+
if (annotations && annotations.length > 0) {
152+
await core.group(`Generating GitHub annotations (${annotations.length} build checks found)`, async () => {
153+
for (const annotation of annotations) {
154+
core.warning(annotation.message, annotation);
155+
}
156+
});
157+
}
158+
}
159+
}
160+
141161
await core.group(`Check build summary support`, async () => {
142162
if (!buildSummaryEnabled()) {
143163
core.info('Build summary disabled');
@@ -222,6 +242,13 @@ async function buildRef(toolkit: Toolkit, since: Date, builder?: string): Promis
222242
return Object.keys(refs).length > 0 ? Object.keys(refs)[0] : '';
223243
}
224244

245+
function buildChecksAnnotationsEnabled(): boolean {
246+
if (process.env.DOCKER_BUILD_CHECKS_ANNOTATIONS) {
247+
return Util.parseBool(process.env.DOCKER_BUILD_CHECKS_ANNOTATIONS);
248+
}
249+
return true;
250+
}
251+
225252
function buildSummaryEnabled(): boolean {
226253
if (process.env.DOCKER_BUILD_NO_SUMMARY) {
227254
core.warning('DOCKER_BUILD_NO_SUMMARY is deprecated. Set DOCKER_BUILD_SUMMARY to false instead.');

‎test/lint.Dockerfile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
frOM busybox as base
2+
cOpy lint.Dockerfile .
3+
4+
from scratch
5+
MAINTAINER [email protected]
6+
COPy --from=base \
7+
/lint.Dockerfile \
8+
/
9+
10+
CMD [ "echo", "Hello, Norway!" ]
11+
CMD [ "echo", "Hello, Sweden!" ]
12+
ENTRYPOINT my-program start

0 commit comments

Comments
 (0)