GitHub Actions for lint #3211

crazy-max · 2021-07-26T15:19:05Z

First step to switch from CircleCI to GitHub Actions for lint.

shellcheck and lint Dockerfiles have also been simplified and don't need to be built and run.

Have also added new bake targets for that:

docker buildx bake lint or make -f docker.Makefile lint
docker buildx bake shellcheck or make -f docker.Makefile shellcheck

cc @thaJeztah

Signed-off-by: CrazyMax [email protected]

crazy-max · 2021-07-26T15:33:48Z

We could also cleanup docker.Makefile in a follow-up.

Makefile

dockerfiles/Dockerfile.shellcheck

codecov-commenter · 2021-07-26T19:21:56Z

Codecov Report

Merging #3211 (698c155) into master (13e4a09) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3211   +/-   ##
=======================================
  Coverage   58.58%   58.58%           
=======================================
  Files         299      299           
  Lines       21502    21502           
=======================================
  Hits        12597    12597           
  Misses       7983     7983           
  Partials      922      922

dockerfiles/Dockerfile.lint

dockerfiles/Dockerfile.shellcheck

docker-bake.hcl

docker.Makefile

thaJeztah · 2021-07-29T11:03:26Z

Whoops; this needs a rebase, because the go1.16 update was merged

crazy-max · 2021-07-29T11:27:37Z

Whoops; this needs a rebase, because the go1.16 update was merged

Ah yes indeed, will do that

crazy-max · 2021-07-29T12:22:09Z

@thaJeztah After rebase looks like there are some warnings with golangci-lint which are not visible on CircleCI:

#16 [lint 1/1] RUN --mount=type=bind,target=.,rw   --mount=type=cache,target=/root/.cache/go-build   --mount=type=cache,target=/root/.cache/golangci-lint   --mount=from=golangci-lint,source=/usr/bin/golangci-lint,target=/usr/bin/golangci-lint    golangci-lint run --config=.golangci.yml
#16 85.79 level=warning msg="[runner] Can't run linter unused: buildssa: analysis skipped: errors in package: [/go/src/github.com/docker/cli/cli/config/credentials/default_store.go:4:7: could not import golang.org/x/sys/execabs (/go/src/github.com/docker/cli/vendor/golang.org/x/sys/execabs/execabs.go:17:2: could not import context (/usr/local/go/src/context/context.go:51:2: could not import errors (/usr/local/go/src/errors/wrap.go:8:2: could not import internal/reflectlite (/usr/local/go/src/internal/reflectlite/swapper.go:8:2: could not import internal/unsafeheader (-: could not load export data: cannot import \"internal/unsafeheader\" (unknown iexport format version 1), export data is newer version - update tool))))) /go/src/github.com/docker/cli/cli/config/credentials/default_store_linux.go:4:2: could not import os/exec (/usr/local/go/src/os/exec/exec.go:24:2: could not import bytes (/usr/local/go/src/bytes/buffer.go:10:2: could not import errors (/usr/local/go/src/errors/wrap.go:8:2: could not import internal/reflectlite (/usr/local/go/src/internal/reflectlite/swapper.go:8:2: could not import internal/unsafeheader (-: could not load export data: cannot import \"internal/unsafeheader\" (unknown iexport format version 1), export data is newer version - update tool))))) /go/src/github.com/docker/cli/cli/config/credentials/file_store.go:4:2: could not import strings (/usr/local/go/src/strings/builder.go:8:2: could not import unicode/utf8 (-: could not load export data: cannot import \"unicode/utf8\" (unknown iexport format version 1), export data is newer version - update tool)) /go/src/github.com/docker/cli/cli/config/credentials/native_store.go:5:2: could not import github.com/docker/docker-credential-helpers/client (/go/src/github.com/docker/cli/vendor/github.com/docker/docker-credential-helpers/client/client.go:4:2: could not import bytes (/usr/local/go/src/bytes/buffer.go:10:2: could not import errors (/usr/local/go/src/errors/wrap.go:8:2: could not import internal/reflectlite (/usr/local/go/src/internal/reflectlite/swapper.go:8:2: could not import internal/unsafeheader (-: could not load export data: cannot import \"internal/unsafeheader\" (unknown iexport format version 1), export data is newer version - update tool))))) /go/src/github.com/docker/cli/cli/config/credentials/native_store.go:6:2: could not import github.com/docker/docker-credential-helpers/credentials (/go/src/github.com/docker/cli/vendor/github.com/docker/docker-credential-helpers/credentials/credentials.go:4:2: could not import bufio (/usr/local/go/src/bufio/bufio.go:11:2: could not import bytes (/usr/local/go/src/bytes/buffer.go:10:2: could not import errors (/usr/local/go/src/errors/wrap.go:8:2: could not import internal/reflectlite (/usr/local/go/src/internal/reflectlite/swapper.go:8:2: could not import internal/unsafeheader (-: could not load export data: cannot import \"internal/unsafeheader\" (unknown iexport format version 1), export data is newer version - update tool))))))]"
#16 86.33 level=warning msg="[runner] Can't run linter goanalysis_metalinter: assign: failed prerequisites: [email protected]/docker/cli/cli/context"

Looks linked to golangci/golangci-lint#885. 1.23.8 fixed the issue.

.github/workflows/validate.yml

thaJeztah · 2021-08-05T00:02:16Z

.github/workflows/validate.yml

+      fail-fast: false
+      matrix:
+        target:
+          - lint


The official golangci-lint GitHub Action can also run on Windows, Darwin. Wondering if we can trick it by setting GOOS/GOARCH to also lint non-matching platforms (especially for the CLI, which will be extensively used on macOS and Windows)

Yes I think we can have a special matrix to run Windows and MacOS runners in this case. We can do that in follow-up.

Yeah, it's tricky, because of course we can't run a macOS container, and Windows doesn't support BuildKit for Windows containers (if it would, it's still possible that building takes a long time (Moby Ci can take 10 minutes to build the Dockerfile, a large portion of that is taken by just pulling the base image 😞).

So if it's possible to somehow trick golangci-lint (through GOOS / GOARCH) that would be a lot easier.

If not, then perhaps (for CI) we would have to consider using the official golangci-lint GitHub action, which doesn't (I think?) run containerised, but at least runs fast (and on Windows and macOS). We can still use the BuildKit approach for local use (and for Linux perhaps).

@thaJeztah

using the official golangci-lint GitHub action

Yes I think we can do that with https://github.com/golangci/golangci-lint-action for Win/MacOS.

docker.Makefile

dockerfiles/Dockerfile.lint

dockerfiles/Dockerfile.shellcheck

Signed-off-by: CrazyMax <[email protected]>

thaJeztah

LGTM, thanks!

thaJeztah · 2021-08-05T10:37:02Z

@silvin-lubecki PTAL

silvin-lubecki

Looks good, thanks @crazy-max !

crazy-max force-pushed the gha branch 2 times, most recently from f1f3394 to 2580dea Compare July 26, 2021 15:25

crazy-max marked this pull request as ready for review July 26, 2021 15:31

thaJeztah reviewed Jul 26, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

Makefile Outdated Show resolved Hide resolved

dockerfiles/Dockerfile.shellcheck Show resolved Hide resolved

thaJeztah added area/testing status/2-code-review labels Jul 26, 2021

crazy-max requested a review from thaJeztah July 26, 2021 19:23

thaJeztah requested changes Jul 29, 2021

View reviewed changes

crazy-max force-pushed the gha branch 2 times, most recently from 911c49e to ca626e1 Compare July 29, 2021 12:09

crazy-max force-pushed the gha branch from ca626e1 to dc9f813 Compare July 29, 2021 12:22

crazy-max requested a review from thaJeztah July 29, 2021 12:26

crazy-max force-pushed the gha branch 2 times, most recently from e2fcecf to 62d6940 Compare July 29, 2021 16:19

thaJeztah reviewed Aug 5, 2021

View reviewed changes

GitHub Actions for lint

698c155

Signed-off-by: CrazyMax <[email protected]>

crazy-max force-pushed the gha branch from 62d6940 to 698c155 Compare August 5, 2021 06:44

crazy-max requested a review from thaJeztah August 5, 2021 06:47

thaJeztah approved these changes Aug 5, 2021

View reviewed changes

silvin-lubecki approved these changes Aug 5, 2021

View reviewed changes

silvin-lubecki merged commit aa949f2 into docker:master Aug 5, 2021

crazy-max deleted the gha branch August 5, 2021 12:12

thaJeztah added this to the 21.xx milestone Aug 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Actions for lint #3211

GitHub Actions for lint #3211

crazy-max commented Jul 26, 2021 •

edited

Loading

crazy-max commented Jul 26, 2021

codecov-commenter commented Jul 26, 2021 •

edited

Loading

thaJeztah commented Jul 29, 2021

crazy-max commented Jul 29, 2021

crazy-max commented Jul 29, 2021

thaJeztah Aug 5, 2021

crazy-max Aug 5, 2021 •

edited

Loading

thaJeztah Aug 5, 2021

crazy-max Aug 5, 2021

thaJeztah left a comment

thaJeztah commented Aug 5, 2021

silvin-lubecki left a comment

GitHub Actions for lint #3211

GitHub Actions for lint #3211

Conversation

crazy-max commented Jul 26, 2021 • edited Loading

crazy-max commented Jul 26, 2021

codecov-commenter commented Jul 26, 2021 • edited Loading

Codecov Report

thaJeztah commented Jul 29, 2021

crazy-max commented Jul 29, 2021

crazy-max commented Jul 29, 2021

thaJeztah Aug 5, 2021

Choose a reason for hiding this comment

crazy-max Aug 5, 2021 • edited Loading

Choose a reason for hiding this comment

thaJeztah Aug 5, 2021

Choose a reason for hiding this comment

crazy-max Aug 5, 2021

Choose a reason for hiding this comment

thaJeztah left a comment

Choose a reason for hiding this comment

thaJeztah commented Aug 5, 2021

silvin-lubecki left a comment

Choose a reason for hiding this comment

crazy-max commented Jul 26, 2021 •

edited

Loading

codecov-commenter commented Jul 26, 2021 •

edited

Loading

crazy-max Aug 5, 2021 •

edited

Loading