Skip to content

Commit 0effb2c

Browse files
committed
Document that gems.rb/gems.locked is supported now
1 parent b62e5d5 commit 0effb2c

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ if they are not at the root of the repository, see [action.yml](action.yml) for
115115

116116
### Bundler
117117

118-
By default, if there is a `Gemfile.lock` file (or `$BUNDLE_GEMFILE.lock` if `$BUNDLE_GEMFILE` is set) with a `BUNDLED WITH` section,
118+
By default, if there is a `Gemfile.lock` file (or `$BUNDLE_GEMFILE.lock` or `gems.locked`) with a `BUNDLED WITH` section,
119119
the latest version of Bundler with the same major version will be installed.
120120
Otherwise, the latest compatible Bundler version is installed (Bundler 2 on Ruby >= 2.4, Bundler 1 on Ruby < 2.4).
121121

@@ -131,9 +131,8 @@ This action provides a way to automatically run `bundle install` and cache the r
131131
```
132132

133133
This caching speeds up installing gems significantly and avoids too many requests to RubyGems.org.
134-
It needs a `Gemfile` (or `$BUNDLE_GEMFILE`) under the [`working-directory`](#working-directory).
135-
The caching works whether there is a `Gemfile.lock` or not.
136-
If there is a `Gemfile.lock`, `bundle config --local deployment true` is used.
134+
It needs a `Gemfile` (or `$BUNDLE_GEMFILE` or `gems.rb`) under the [`working-directory`](#working-directory).
135+
If there is a `Gemfile.lock` (or `$BUNDLE_GEMFILE.lock` or `gems.locked`), `bundle config --local deployment true` is used.
137136

138137
To perform caching, this action will use `bundle config --local path vendor/bundle`.
139138
Therefore, the Bundler `path` should not be changed in your workflow for the cache to work.

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ inputs:
1212
bundler:
1313
description: |
1414
The version of Bundler to install. Either 'none', 1, 2, 'latest' or 'Gemfile.lock'.
15-
For 'Gemfile.lock', the version is determined based on the BUNDLED WITH section from the file ($BUNDLE_GEMFILE || Gemfile).lock.
16-
Defaults to 'Gemfile.lock' if it exists and 'latest' otherwise.
15+
For 'Gemfile.lock', the version is determined based on the BUNDLED WITH section from the file Gemfile.lock, $BUNDLE_GEMFILE.lock or gems.locked.
16+
Defaults to 'Gemfile.lock' if the file exists and 'latest' otherwise.
1717
required: false
1818
default: 'default'
1919
bundler-cache:

0 commit comments

Comments
 (0)