Skip to content

Commit

Permalink
update changelog and documentation for v0.8.6 (#3920)
Browse files Browse the repository at this point in the history
Update changelog and docs for v0.8.6
  • Loading branch information
idodod committed Mar 18, 2024
1 parent cf09bba commit b20c1db
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 4 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ All notable changes to [Earthly](https://github.com/earthly/earthly) will be doc

## Unreleased

## v0.8.6 - 2024-03-18

### Added

- Ability to set arbitrary attributes which certain registries require to support explicit remote caching (via the `earthly --remote-cache` flag). [#3714](https://github.com/earthly/earthly/issues/3714) and [#3868](https://github.com/earthly/earthly/issues/3868)

### Fixed

- Fixed an issue in Auto-skip where a `+base` target's ARGs were not accounted for when calculating the cache. [#3895](https://github.com/earthly/earthly/issues/3895)

### Additional Info
- This release has no changes to buildkit

## v0.8.5 - 2024-03-11

### Added
Expand Down
2 changes: 1 addition & 1 deletion cmd/earthly/flag/global.go
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ func (global *Global) RootFlags(installName string, bkImage string) []cli.Flag {
&cli.StringFlag{
Name: "remote-cache",
EnvVars: []string{"EARTHLY_REMOTE_CACHE"},
Usage: "A remote docker image tag use as explicit cache",
Usage: "A remote docker image tag use as explicit cache and optionally additional attributes to set in the image (Format: \"<image-tag>[,<attr1>=<val1>,<attr2>=<val2>,...]\")",
Destination: &global.RemoteCache,
},
&cli.BoolFlag{
Expand Down
9 changes: 9 additions & 0 deletions docs/caching/caching-via-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,15 @@ On developer's computer (optional):
earthly --remote-cache=mycompany/myimage:cache +some-target
```

##### Additional Image Attributes

Some Registry Providers require setting certain attributes so that they can be used for explicit caching.
These attributes can be set in the ``--remote-cache` flag, for example:

```bash
earthly --remote-cache=harbor.company.team/earthly-cache/test:cache,image-manifest=true,oci-mediatypes=true +example
```

The options mentioned above are also available as environment variables. See [Earthly command reference](../earthly-command/earthly-command.md) for more information.

{% hint style='info' %}
Expand Down
8 changes: 5 additions & 3 deletions docs/earthly-command/earthly-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,11 +267,13 @@ Also available as an env var setting: `EARTHLY_SAVE_INLINE_CACHE=true`

Enables embedding inline cache in any pushed images. This cache can be used on other systems, if enabled via `--use-inline-cache`. For more information see the [remote caching guide](../caching/caching-via-registry.md).

##### `--remote-cache <image-tag>`
##### `--remote-cache <image-tag>[,<attr1>=<val1>,<attr2>=<val2>,...]`

Also available as an env var setting: `EARTHLY_REMOTE_CACHE=<image-tag>`
Also available as an env var setting: `EARTHLY_REMOTE_CACHE=<image-tag>[,<attr1>=<val1>,<attr2>=<val2>,...]`

Enables use of explicit cache. The provided `<image-tag>` is used for storing and retrieving the cache to/from a Docker registry. Storing explicit cache is only enabled if the option `--push` is also passed in. For more information see the [remote caching guide](../caching/caching-via-registry.md).
Enables use of explicit cache. The provided `<image-tag>` is used for storing and retrieving the cache to/from a Docker registry. Storing explicit cache is only enabled if the option `--push` is also passed in.
Additional attributes can be optionally set for certain registry providers to be supported.
For more information see the [remote caching guide](../caching/caching-via-registry.md).

##### `--max-remote-cache`

Expand Down

0 comments on commit b20c1db

Please sign in to comment.