Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Docker CLI
9,240 Commits 11 Branches 241 Tags 240 MiB
Go 91.3%
Shell 5.8%
Go-Checksums 1.3%
Dockerfile 1.1%
Makefile 0.3%
Other 0.2%
Go to file
Sebastiaan van Stijn 70216b662d
add //go:build directives to prevent downgrading to go1.16 language 
This is a follow-up to 0e73168b7e

This repository is not yet a module (i.e., does not have a `go.mod`). This
is not problematic when building the code in GOPATH or "vendor" mode, but
when using the code as a module-dependency (in module-mode), different semantics
are applied since Go1.21, which switches Go _language versions_ on a per-module,
per-package, or even per-file base.

A condensed summary of that logic [is as follows][1]:

- For modules that have a go.mod containing a go version directive; that
  version is considered a minimum _required_ version (starting with the
  go1.19.13 and go1.20.8 patch releases: before those, it was only a
  recommendation).
- For dependencies that don't have a go.mod (not a module), go language
  version go1.16 is assumed.
- Likewise, for modules that have a go.mod, but the file does not have a
  go version directive, go language version go1.16 is assumed.
- If a go.work file is present, but does not have a go version directive,
  language version go1.17 is assumed.

When switching language versions, Go _downgrades_ the language version,
which means that language features (such as generics, and `any`) are not
available, and compilation fails. For example:

    # github.com/docker/cli/cli/context/store
    /go/pkg/mod/github.com/docker/cli@v25.0.0-beta.2+incompatible/cli/context/store/storeconfig.go:6:24: predeclared any requires go1.18 or later (-lang was set to go1.16; check go.mod)
    /go/pkg/mod/github.com/docker/cli@v25.0.0-beta.2+incompatible/cli/context/store/store.go:74:12: predeclared any requires go1.18 or later (-lang was set to go1.16; check go.mod)

Note that these fallbacks are per-module, per-package, and can even be
per-file, so _(indirect) dependencies_ can still use modern language
features, as long as their respective go.mod has a version specified.

Unfortunately, these failures do not occur when building locally (using
vendor / GOPATH mode), but will affect consumers of the module.

Obviously, this situation is not ideal, and the ultimate solution is to
move to go modules (add a go.mod), but this comes with a non-insignificant
risk in other areas (due to our complex dependency tree).

We can revert to using go1.16 language features only, but this may be
limiting, and may still be problematic when (e.g.) matching signatures
of dependencies.

There is an escape hatch: adding a `//go:build` directive to files that
make use of go language features. From the [go toolchain docs][2]:

> The go line for each module sets the language version the compiler enforces
> when compiling packages in that module. The language version can be changed
> on a per-file basis by using a build constraint.
>
> For example, a module containing code that uses the Go 1.21 language version
> should have a `go.mod` file with a go line such as `go 1.21` or `go 1.21.3`.
> If a specific source file should be compiled only when using a newer Go
> toolchain, adding `//go:build go1.22` to that source file both ensures that
> only Go 1.22 and newer toolchains will compile the file and also changes
> the language version in that file to Go 1.22.

This patch adds `//go:build` directives to those files using recent additions
to the language. It's currently using go1.19 as version to match the version
in our "vendor.mod", but we can consider being more permissive ("any" requires
go1.18 or up), or more "optimistic" (force go1.21, which is the version we
currently use to build).

For completeness sake, note that any file _without_ a `//go:build` directive
will continue to use go1.16 language version when used as a module.

[1]: 58c28ba286/src/cmd/go/internal/gover/version.go (L9-L56)
[2]; https://go.dev/doc/toolchain#:~:text=The%20go%20line%20for,file%20to%20Go%201.22

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 		2023-12-14 15:03:46 +01:00
.circleci dummy circleci config 2022-02-25 21:15:39 +01:00
.github build(deps): bump github/codeql-action from 2 to 3 2023-12-14 08:33:33 +00:00
cli add //go:build directives to prevent downgrading to go1.16 language 2023-12-14 15:03:46 +01:00
cli-plugins add //go:build directives to prevent downgrading to go1.16 language 2023-12-14 15:03:46 +01:00
cmd/docker add //go:build directives to prevent downgrading to go1.16 language 2023-12-14 15:03:46 +01:00
contrib/completion contrib/completion: remove logentries logging-driver 2023-12-13 13:15:14 +01:00
dockerfiles update to go1.21.5 2023-12-05 23:53:29 +01:00
docs docs: run-reference: use table for health options 2023-12-13 16:00:10 +01:00
e2e Plumb contexts through commands 2023-12-12 22:30:16 +01:00
experimental experimental: fix broken link to "checkpoint and restore" page 2021-09-07 13:30:48 +02:00
internal/test golangci-lint: revive: enable import-shadowing 2023-11-20 19:52:41 +01:00
man docs, man: remove logentries logging-driver 2023-12-13 13:16:31 +01:00
opts Permit '=' separator and '[ipv6]' in --add-host 2023-12-07 18:29:19 +00:00
scripts update go-md2man to v2.0.3 2023-10-11 18:26:14 +02:00
service/logs service/logs: use strings.Cut 2022-12-29 15:19:31 +01:00
templates add //go:build directives to prevent downgrading to go1.16 language 2023-12-14 15:03:46 +01:00
vendor vendor: github.com/docker/docker f3cc93630ed8 (v25.0.0-dev) 2023-12-13 12:48:42 +01:00
.dockerignore validate manpages target 2022-02-25 17:11:17 +01:00
.gitattributes fix linguist with .gitattributes 2021-12-16 21:16:02 +01:00
.gitignore validate manpages target 2022-02-25 17:11:17 +01:00
.golangci.yml templates: linting: fix "error return value is not checked (errchkjson) 2023-11-20 19:52:46 +01:00
.mailmap update authors and mailmap 2023-11-13 22:32:27 +01:00
AUTHORS update authors and mailmap 2023-11-13 22:32:27 +01:00
CONTRIBUTING.md - What I did 2023-10-19 16:10:27 -04:00
Dockerfile update to go1.21.5 2023-12-05 23:53:29 +01:00
LICENSE Add project files 2017-04-17 17:49:33 -04:00
MAINTAINERS not actually a maintainer 2023-11-10 21:35:15 +01:00
Makefile docs: generate markdown 2023-01-06 22:36:47 +01:00
NOTICE switch kr/pty to creack/pty v1.1.7 2019-07-29 16:45:41 -07:00
README.md Readme: remove reference to "Docker EE" 2023-11-28 10:23:11 +01:00
TESTING.md tweak description of login/logout 2022-04-04 10:44:11 +02:00
VERSION Update version to v25.0.0-dev 2023-05-08 08:57:19 +02:00
codecov.yml Drop support for (archived) Compose-on-Kubernetes 2022-02-22 13:47:34 +01:00
docker-bake.hcl update to go1.21.5 2023-12-05 23:53:29 +01:00
docker.Makefile docs: generate markdown 2023-01-06 22:36:47 +01:00
vendor.mod vendor: github.com/docker/docker f3cc93630ed8 (v25.0.0-dev) 2023-12-13 12:48:42 +01:00
vendor.sum vendor: github.com/docker/docker f3cc93630ed8 (v25.0.0-dev) 2023-12-13 12:48:42 +01:00

README.md

Docker CLI

PkgGoDev Build Status Test Status Go Report Card Codecov

About

This repository is the home of the Docker CLI.

Development

docker/cli is developed using Docker.

Build CLI from source:

docker buildx bake

Build binaries for all supported platforms:

docker buildx bake cross

Build for a specific platform:

docker buildx bake --set binary.platform=linux/arm64

Build dynamic binary for glibc or musl:

USE_GLIBC=1 docker buildx bake dynbinary

Run all linting:

docker buildx bake lint shellcheck

Run test:

docker buildx bake test

List all the available targets:

make help

In-container development environment

Start an interactive development environment:

make -f docker.Makefile shell

Legal

Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.

Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.

It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see https://www.bis.doc.gov

Licensing

docker/cli is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.