actions/setup-ruby
1
0
Fork 0
mirror of https://github.com/ruby/setup-ruby.git synced 2026-09-13 14:34:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the cleanups when using bundler-cache: true

Browse Source
This commit is contained in:
Benoit Daloze
2020-10-22 14:10:27 +02:00
committed by GitHub
parent a195098f6b
commit 60f215c278
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -1
View File
@@ -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