From 60f215c278968be8b2b2a766052b30b03c0a21ad Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Thu, 22 Oct 2020 14:10:27 +0200 Subject: [PATCH] Clarify the cleanups when using bundler-cache: true --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c38d4dc..36c0944 100644 --- a/README.md +++ b/README.md @@ -131,12 +131,14 @@ This action provides a way to automatically run `bundle install` and cache the r bundler-cache: true ``` +Note that any step doing `bundle install` (for the root `Gemfile`) or `gem install bundler` can be removed with `bundler-cache: true`. + This caching speeds up installing gems significantly and avoids too many requests to RubyGems.org. It needs a `Gemfile` (or `$BUNDLE_GEMFILE` or `gems.rb`) under the [`working-directory`](#working-directory). If there is a `Gemfile.lock` (or `$BUNDLE_GEMFILE.lock` or `gems.locked`), `bundle config --local deployment true` is used. To perform caching, this action will use `bundle config --local path vendor/bundle`. -Therefore, the Bundler `path` should not be changed in your workflow for the cache to work. +Therefore, the Bundler `path` should not be changed in your workflow for the cache to work (no `bundle config path`). ### Caching `bundle install` manually