Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test lint annotations #39

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1346,3 +1346,27 @@ jobs:
name: Check docker
run: |
docker image inspect localhost:5000/name/app:latest

lint:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v4
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
with:
# TODO: use v0.14.0 when GA
version: v0.14.0-rc1
# TODO: use buildx-stable-1 image when v0.14 promoted
driver-opts: |
network=host
image=moby/buildkit:master@sha256:baee1d09b849fa6dbbcf7ae407f50eff5c0de47b52f11d78543817d3395441bb
buildkitd-flags: --debug
-
name: Build
uses: ./
with:
context: ./test
file: ./test/lint.Dockerfile
2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

36 changes: 36 additions & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ actionsToolkit.run(
core.debug(`buildCmd.command: ${buildCmd.command}`);
core.debug(`buildCmd.args: ${JSON.stringify(buildCmd.args)}`);

await runLint(buildCmd.command, buildCmd.args, inputs, toolkit);

await Exec.getExecOutput(buildCmd.command, buildCmd.args, {
ignoreReturnCode: true
}).then(res => {
Expand Down Expand Up @@ -121,3 +123,37 @@ actionsToolkit.run(
}
}
);

async function runLint(cmd: string, args: Array<string>, inputs: context.Inputs, toolkit: Toolkit): Promise<void> {
if (!(await toolkit.buildx.versionSatisfies('>=0.14.0'))) {
return;
}
await core.group(`Dockerfile lint`, async () => {
await Exec.getExecOutput(cmd, [...args, '--print=lint,format=json'], {
ignoreReturnCode: true,
env: Object.assign({}, process.env, {
BUILDX_EXPERIMENTAL: '1'
}) as {
[key: string]: string;
}
}).then(res => {
if (res.stderr.length > 0 && res.exitCode != 0) {
throw new Error(`buildx failed with: ${res.stderr.match(/(.*)\s*$/)?.[0]?.trim() ?? 'unknown error'}`);
}
const out = JSON.parse(res.stdout);
if (out['warnings'] && out['warnings'].length > 0) {
// const sourceData = Buffer.from(out['sources'][0].data, 'base64').toString('utf8');
// core.info(`sourceData: ${sourceData}`);
out['warnings'].forEach(lint => {
core.warning(lint.description, {
title: lint.detail,
file: inputs.file || 'Dockerfile',
startLine: lint.location.ranges[0].start.line
});
});
} else {
core.info('No lint issues found');
}
});
});
}
8 changes: 8 additions & 0 deletions test/lint.Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# syntax=docker/dockerfile-upstream:master
frOM busybox as base

Check warning on line 2 in test/lint.Dockerfile

View workflow job for this annotation

GitHub Actions / lint

Lint Rule 'SelfConsistentCommandCasing': Command 'frOM' should be consistently cased (line 2)

Commands should be in consistent casing (all lower or all upper)
cOpy lint.Dockerfile .

Check warning on line 3 in test/lint.Dockerfile

View workflow job for this annotation

GitHub Actions / lint

Lint Rule 'SelfConsistentCommandCasing': Command 'cOpy' should be consistently cased (line 3)

Commands should be in consistent casing (all lower or all upper)

from scratch
COPy --from=base \

Check warning on line 6 in test/lint.Dockerfile

View workflow job for this annotation

GitHub Actions / lint

Lint Rule 'SelfConsistentCommandCasing': Command 'COPy' should be consistently cased (line 6)

Commands should be in consistent casing (all lower or all upper)
/lint.Dockerfile \
/
Loading