From 0effb2cc506cf040247c79dbfba54d93b11e3df8 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Sat, 19 Sep 2020 11:43:36 +0200 Subject: [PATCH] Document that gems.rb/gems.locked is supported now --- README.md | 7 +++---- action.yml | 4 ++-- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2c82528..eeec8c5 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ if they are not at the root of the repository, see [action.yml](action.yml) for ### Bundler -By default, if there is a `Gemfile.lock` file (or `$BUNDLE_GEMFILE.lock` if `$BUNDLE_GEMFILE` is set) with a `BUNDLED WITH` section, +By default, if there is a `Gemfile.lock` file (or `$BUNDLE_GEMFILE.lock` or `gems.locked`) with a `BUNDLED WITH` section, the latest version of Bundler with the same major version will be installed. Otherwise, the latest compatible Bundler version is installed (Bundler 2 on Ruby >= 2.4, Bundler 1 on Ruby < 2.4). @@ -131,9 +131,8 @@ This action provides a way to automatically run `bundle install` and cache the r ``` This caching speeds up installing gems significantly and avoids too many requests to RubyGems.org. -It needs a `Gemfile` (or `$BUNDLE_GEMFILE`) under the [`working-directory`](#working-directory). -The caching works whether there is a `Gemfile.lock` or not. -If there is a `Gemfile.lock`, `bundle config --local deployment true` is used. +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. diff --git a/action.yml b/action.yml index 0d05c69..e75c3ce 100644 --- a/action.yml +++ b/action.yml @@ -12,8 +12,8 @@ inputs: bundler: description: | The version of Bundler to install. Either 'none', 1, 2, 'latest' or 'Gemfile.lock'. - For 'Gemfile.lock', the version is determined based on the BUNDLED WITH section from the file ($BUNDLE_GEMFILE || Gemfile).lock. - Defaults to 'Gemfile.lock' if it exists and 'latest' otherwise. + For 'Gemfile.lock', the version is determined based on the BUNDLED WITH section from the file Gemfile.lock, $BUNDLE_GEMFILE.lock or gems.locked. + Defaults to 'Gemfile.lock' if the file exists and 'latest' otherwise. required: false default: 'default' bundler-cache: