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

Make it clear bundler-cache: true is correct, and doing it manually is not good enough

Browse Source
This commit is contained in:
Benoit Daloze
2020-12-30 16:57:15 +01:00
committed by GitHub
parent 0d3b8b502e
commit ce63da5b3b
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -2
View File
@@ -162,13 +162,17 @@ If there is a `Gemfile.lock` (or `$BUNDLE_GEMFILE.lock` or `gems.locked`), `bund
To use a `Gemfile` which is not at the root or has a different name, set `BUNDLE_GEMFILE` in the `env` at the job level To use a `Gemfile` which is not at the root or has a different name, set `BUNDLE_GEMFILE` in the `env` at the job level
as shown in the [example](#matrix-of-gemfiles). as shown in the [example](#matrix-of-gemfiles).
When there is no lockfile, one is generated with `bundle lock`, which is the same as `bundle install` would do first before actually fetching any gem.
In other words, it works exactly like `bundle install`.
The hash of the generated lockfile is then used for caching, which is the only correct approach.
To perform caching, this action will use `bundle config --local path $PWD/vendor/bundle`. To perform caching, this action will use `bundle config --local path $PWD/vendor/bundle`.
Therefore, the Bundler `path` should not be changed in your workflow for the cache to work (no `bundle config path`). Therefore, the Bundler `path` should not be changed in your workflow for the cache to work (no `bundle config path`).
#### Caching `bundle install` manually #### Caching `bundle install` manually
It is also possible to cache gems manually, It is also possible to cache gems manually, but this is not recommended because it is verbose and *very difficult* to do correctly.
but this is not recommended because it is verbose and *very difficult* to use a correct cache key. There are many concerns which means using `actions/cache` is never enough for caching gems (e.g., incomplete cache key, cleaning old gems when restoring from another key, correctly hashing the lockfile if not checked in, OS versions, ABI compatibility for `ruby-head`, etc).
So, please use `bundler-cache: true` instead and report any issue. So, please use `bundler-cache: true` instead and report any issue.
## Windows ## Windows