Determine default cache map from Dockerfile by bennesp · Pull Request #49 · reproducible-containers/buildkit-cache-dance

bennesp · 2025-04-22T12:54:06Z

Closes #48 (thank you @omus for sharing a very useful code snippet)

This PR allows users to avoid specifying cache-map: the cache-map will be automatically created by inspecting the AST of the Dockerfile. Of course, users can continue specifying cache-map, in situations where users need more control.

Users can specify a Dockerfile of their choice with the dockerfile option.

For each cache mount, the respective generated cache-map entry is the following:

cache-map source: The id of the cache mount if specified, otherwise the target of the cache mount
cache-map target: The absolute path of the target (prefixed by the WORKDIR, if any)

Example:

FROM alpine:latest AS builder

# Target absolute path, no id
RUN --mount=type=cache,target=/tmp/cache \
    echo "Hello, World!" > /tmp/cache/hello.txt

# Target relative path with workdir, no id
WORKDIR /app
RUN --mount=type=cache,target=cache1 \
    echo "Hello, World!" > cache/hello.txt

# Multi-stage build
FROM alpine:latest

# Target absolute path with id
RUN --mount=type=cache,id=cache2,target=/tmp/cache \
    echo "Hello, World!" > /tmp/cache/hello.txt

# Target relative path with workdir and id
WORKDIR /app2
RUN --mount=type=cache,id=cache3,target=cache \
    echo "Hello, World!" > cache/hello.txt

This dockerfile will generate the following cache-map:

{
  "/tmp/cache": {
      "id": "/tmp/cache",
      "target": "/var/cache-target"
  },
  "cache1": {
      "id": "cache1",
      "target": "/var/cache-target"
  },
  "cache2": {
      "id": "cache2",
      "target": "/var/cache-target"
  },
  "cache3": {
      "id": "cache3",
      "target": "/var/cache-target"
  }
}

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

omus

Thanks!

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

bennesp · 2025-05-02T08:38:32Z

@AkihiroSuda do you think you could kindly take a look at this PR? 🙏

AkihiroSuda

Thanks

AkihiroSuda · 2025-05-03T11:56:00Z

Next time please consider squashing commits

bennesp · 2025-05-03T12:13:13Z

Thank you for the quick response, I will squash next time!
Best

…it-cache-dance action to v3.2.0 (#23) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [https://github.com/reproducible-containers/buildkit-cache-dance](https://github.com/reproducible-containers/buildkit-cache-dance) | action | minor | `v3.1.0` -> `v3.2.0` | --- ### Release Notes <details> <summary>reproducible-containers/buildkit-cache-dance (https://github.com/reproducible-containers/buildkit-cache-dance)</summary> ### [`v3.2.0`](https://github.com/reproducible-containers/buildkit-cache-dance/releases/tag/v3.2.0) [Compare Source](reproducible-containers/buildkit-cache-dance@v3.1.2...v3.2.0) #### What's Changed - Allow overriding container image by [@relu](https://github.com/relu) in reproducible-containers/buildkit-cache-dance#44 - Added support for running with different builder by [@ty2](https://github.com/ty2) in reproducible-containers/buildkit-cache-dance#45 - Determine default cache map from Dockerfile by [@bennesp](https://github.com/bennesp) in reproducible-containers/buildkit-cache-dance#49 #### New Contributors - [@relu](https://github.com/relu) made their first contribution in reproducible-containers/buildkit-cache-dance#44 - [@ty2](https://github.com/ty2) made their first contribution in reproducible-containers/buildkit-cache-dance#45 - [@bennesp](https://github.com/bennesp) made their first contribution in reproducible-containers/buildkit-cache-dance#49 **Full Changelog**: reproducible-containers/buildkit-cache-dance@v3.1.2...v3.2.0 ### [`v3.1.2`](https://github.com/reproducible-containers/buildkit-cache-dance/releases/tag/v3.1.2) [Compare Source](reproducible-containers/buildkit-cache-dance@v3.1.1...v3.1.2) #### What's Changed - Fix not preserving uid and/or gid by [@mabrikan](https://github.com/mabrikan) in reproducible-containers/buildkit-cache-dance#35 - Use sudo to clear cache source during extraction by [@rose-m](https://github.com/rose-m) in reproducible-containers/buildkit-cache-dance#37 #### New Contributors - [@mabrikan](https://github.com/mabrikan) made their first contribution in reproducible-containers/buildkit-cache-dance#35 - [@rose-m](https://github.com/rose-m) made their first contribution in reproducible-containers/buildkit-cache-dance#37 **Full Changelog**: reproducible-containers/buildkit-cache-dance@v3.1.1...v3.1.2 ### [`v3.1.1`](https://github.com/reproducible-containers/buildkit-cache-dance/releases/tag/v3.1.1) [Compare Source](reproducible-containers/buildkit-cache-dance@v3.1.0...v3.1.1) #### What's Changed - Ensure scratch directory exists when calling extractCache by [@Chagui-](https://github.com/Chagui-) in reproducible-containers/buildkit-cache-dance#29 - Do not extract cache on job failure by [@borchero](https://github.com/borchero) in reproducible-containers/buildkit-cache-dance#32 #### New Contributors - [@Chagui-](https://github.com/Chagui-) made their first contribution in reproducible-containers/buildkit-cache-dance#29 - [@borchero](https://github.com/borchero) made their first contribution in reproducible-containers/buildkit-cache-dance#32 **Full Changelog**: reproducible-containers/buildkit-cache-dance@v3.1.0...v3.1.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.nadeko.net/Fijxu/file-uploader-crystal/pulls/23 Co-authored-by: Renovate Bot <git@nadeko.net> Co-committed-by: Renovate Bot <git@nadeko.net>

bennesp added 2 commits April 22, 2025 15:03

add automatic discovery of caches in Dockerfiles

74013b1

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

update github action yml

2e3c72c

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

bennesp force-pushed the automatic-cache-map-discovery branch from 8a21fcd to ff982a4 Compare April 22, 2025 13:03

omus approved these changes Apr 22, 2025

View reviewed changes

Comment thread action.yml

Comment thread src/opts.ts Outdated

Comment thread src/opts.ts Outdated

bennesp added 2 commits April 22, 2025 22:09

update README.md

dd1601e

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

apply review suggestions

5000ee0

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

bennesp force-pushed the automatic-cache-map-discovery branch from 395734c to 9b9fed1 Compare April 22, 2025 20:12

bennesp added 3 commits April 22, 2025 22:23

simplify getCacheMapFromDockerfile by hardcoding target

58a25ae

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

add messages to make debugging easier

611d172

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

generate dist folder

429cead

Signed-off-by: bennesp <bennesp@users.noreply.github.com>

bennesp force-pushed the automatic-cache-map-discovery branch from dba22cf to 429cead Compare April 22, 2025 20:23

AkihiroSuda approved these changes May 3, 2025

View reviewed changes

AkihiroSuda merged commit 653a570 into reproducible-containers:main May 3, 2025
3 checks passed

omus mentioned this pull request May 27, 2025

Add cache-dir input to allow specifying cache content location during auto-discovery #52

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Determine default cache map from Dockerfile#49

Determine default cache map from Dockerfile#49
AkihiroSuda merged 7 commits intoreproducible-containers:mainfrom
bennesp:automatic-cache-map-discovery

bennesp commented Apr 22, 2025 •

edited

Loading

Uh oh!

omus left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bennesp commented May 2, 2025

Uh oh!

AkihiroSuda left a comment

Uh oh!

Uh oh!

AkihiroSuda commented May 3, 2025

Uh oh!

bennesp commented May 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

bennesp commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Example:

Uh oh!

omus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bennesp commented May 2, 2025

Uh oh!

AkihiroSuda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AkihiroSuda commented May 3, 2025

Uh oh!

bennesp commented May 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bennesp commented Apr 22, 2025 •

edited

Loading