ADD "--checksum" shows a HTTPS example - but claims only HTTP is supported

[mykaul]

trafficstars

Is this a docs issue?

• [X] My issue is about the documentation content or website

Type of issue

Information is incorrect

Description

The example and the text contradict each other: The --checksum flag lets you verify the checksum of a remote resource:

ADD --checksum=sha256:24454f830cdb571e2c4ad15481119c43b3cafd48dd869a9b2945d1036d1dc68d https://mirrors.edge.kernel.org/pub/linux/kernel/Historic/linux-0.01.tar.gz / The --checksum flag only supports HTTP sources currently.

What's the point of providing an HTTPS example, when the checksum only supports HTTP?

Location

https://docs.docker.com/reference/dockerfile/

Suggestion

No response

[thaJeztah]

I suspect the intent here was to describe it's only for remote, HTTP(S) sources (and not for files copied from the local build-context).

cc @dvdksn

[mykaul]

I suspect the intent here was to describe it's only for remote, HTTP(S) sources (and not for files copied from the local build-context).

cc @dvdksn

The result is quite misleading. I'd argue that the code should not be doing any checksum (and even fail this operation!). But at the very least, let's begin with fixing the docs example.

[docker-robot[bot]]

There hasn't been any activity on this issue for a long time. If the problem is still relevant, mark the issue as fresh with a /remove-lifecycle stale comment. If not, this issue will be closed in 14 days. This helps our maintainers focus on the active issues.

Prevent issues from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

[thaJeztah]

Looks like this was fixed through;

• https://github.com/moby/buildkit/pull/5064
• https://github.com/docker/docs/pull/20489

[docker-robot[bot]]

Closed issues are locked after 30 days of inactivity. This helps our team focus on active issues.

If you have found a problem that seems similar to this, please open a new issue.

/lifecycle locked