Skip to content

Commit

Permalink
Improve GitHub cache documentation
Browse files Browse the repository at this point in the history
When using `buildctl`, it's not explained in the documentation that
GitHub attributes `url` and `token` must be manually set to make this works.
That miscomprehension is visible with #2706.

To do not meet that error again, this commit add a precision on how
use GitHub cache with buildctl.

Signed-off-by: Vasek - Tom C <tom.chauveau@epitech.eu>
  • Loading branch information
TomChv committed Mar 4, 2022
1 parent 0a7d890 commit d622a11
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,8 @@ Following attributes are required to authenticate against the [Github Actions Ca
where `url` and `token` will be automatically set. To use this backend in a inline `run` step, you have to include [crazy-max/ghaction-github-runtime](https://github.com/crazy-max/ghaction-github-runtime)
in your workflow to expose the runtime.

:warning: If used directly with `buildctl` CLI, you must inline `url` and `token` attributes. For instance : `type=gha,url=$ACTIONS_CACHE_URL,token=$ACTIONS_RUNTIME_TOKEN`

`--export-cache` options:
* `type=gha`
* `mode=min` (default): only export layers for the resulting image
Expand Down

0 comments on commit d622a11

Please sign in to comment.