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.

Sign up for GitHub

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

docs: replace references to the master branch with v0.13 #4737

Merged
merged 1 commit into from
Mar 7, 2024
Merged

docs: replace references to the master branch with v0.13 #4737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ Keys supported by image output:
* `name-canonical=true`: add additional canonical name `name@<digest>`
* `compression=<uncompressed|gzip|estargz|zstd>`: choose compression type for layers newly created and cached, gzip is default value. estargz should be used with `oci-mediatypes=true`.
* `compression-level=<value>`: compression level for gzip, estargz (0-9) and zstd (0-22)
* `rewrite-timestamp=true` (Present in the `master` branch <!-- TODO: v0.13-->): rewrite the file timestamps to the `SOURCE_DATE_EPOCH` value.
* `rewrite-timestamp=true`: rewrite the file timestamps to the `SOURCE_DATE_EPOCH` value.
See [`docs/build-repro.md`](docs/build-repro.md) for how to specify the `SOURCE_DATE_EPOCH` value.
* `force-compression=true`: forcefully apply `compression` option to all layers (including already existing layers)
* `store=true`: store the result images to the worker's (e.g. containerd) image store as well as ensures that the image has all blobs in the content store (default `true`). Ignored if the worker doesn't have image store (e.g. OCI worker).
Expand Down
9 changes: 2 additions & 7 deletions docs/build-repro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,7 @@ Minimal support is also available on older BuildKit when using Dockerfile 1.5 fr
```console
buildctl build --frontend dockerfile.v0 --opt build-arg:SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) ...
```

The `buildctl` CLI (<= 0.12) does not automatically propagate the `$SOURCE_DATE_EPOCH` environment value from the client host to the `SOURCE_DATE_EPOCH` build arg.
<!-- TODO: s/master/v0.13/ -->
In the `master` branch of BuildKit, the `buildctl` CLI is updated to automatically capture the environment value.
Docker Buildx (>= 0.10) automatically captures the environment value too.
The `buildctl` CLI (>= v0.13) and Docker Buildx (>= 0.10) automatically propagate the `$SOURCE_DATE_EPOCH` environment value from the client host to the `SOURCE_DATE_EPOCH` build arg.

The build arg value is used for:
- the `created` timestamp in the [OCI Image Config](https://github.com/opencontainers/image-spec/blob/main/config.md#properties)
Expand All @@ -64,8 +60,7 @@ To apply the build arg value to the timestamps of the files inside the image, sp
--output type=image,name=docker.io/username/image,push=true,rewrite-timestamp=true
```

<!-- TODO: s/master/v0.13/ -->
The `rewrite-timestamp` option is only available in the `master` branch of BuildKit.
The `rewrite-timestamp` option is available since BuildKit v0.13.
See [v0.12 documentation](https://github.com/moby/buildkit/blob/v0.12/docs/build-repro.md#caveats) for dealing with timestamps
in BuildKit v0.12 and v0.11.

Expand Down
10 changes: 4 additions & 6 deletions frontend/dockerfile/docs/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1575,8 +1575,7 @@ conditions for cache reuse.

> **Note**
>
> Available in [`docker/dockerfile-upstream:master-labs`](#syntax).
> Will be included in `docker/dockerfile:1.7-labs`.
> Not yet available in stable syntax, use [`docker/dockerfile:1.7-labs`](#syntax) version.

```dockerfile
COPY [--parents[=<boolean>]] <src> ... <dest>
Expand All @@ -1585,7 +1584,7 @@ COPY [--parents[=<boolean>]] <src> ... <dest>
The `--parents` flag preserves parent directories for `src` entries. This flag defaults to `false`.

```dockerfile
# syntax=docker/dockerfile-upstream:master-labs
# syntax=docker/dockerfile:1.7-labs
FROM scratch

COPY ./x/a.txt ./y/a.txt /no_parents/
Expand All @@ -1605,7 +1604,7 @@ directories after it will be preserved. This may be especially useful copies bet
with `--from` where the source paths need to be absolute.

```dockerfile
# syntax=docker/dockerfile-upstream:master-labs
# syntax=docker/dockerfile:1.7-labs
FROM scratch

COPY --parents ./x/./y/*.txt /parents/
Expand Down Expand Up @@ -1634,8 +1633,7 @@ with the `--parents` flag, the Buildkit is capable of packing multiple

> **Note**
>
> Available in [`docker/dockerfile-upstream:master-labs`](#syntax).
> Will be included in `docker/dockerfile:1.7-labs`.
> Not yet available in stable syntax, use [`docker/dockerfile:1.7-labs`](#syntax) version.

```dockerfile
COPY [--exclude=<path> ...] <src> ... <dest>
Expand Down