Skip to content

Commit 4662c37

Browse files
MSP-Greglarskanis
andcommitted
action.yml - align with ruby/setup-ruby, add setup-ruby-ref
Co-authored-by: Lars Kanis <lars@greiz-reinsdorf.de>
1 parent 893e350 commit 4662c37

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

action.yml

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,42 +3,73 @@ description: 'Cross platform action for setting up Ruby build environments. Run
33
author: 'MSP-Greg'
44
inputs:
55
ruby-version:
6-
description: 'Used by ruby/setup-ruby. Ruby version. A value of "none" will bypass running ruby/setup-ruby'
6+
description: |
7+
Used by ruby/setup-ruby. Ruby version.
8+
See https://github.com/ruby/setup-ruby/blob/master/README.md.
9+
A value of 'none' will bypass running ruby/setup-ruby.
710
required: false
811
default: 'default'
912
bundler:
10-
description: 'Used by ruby/setup-ruby. The version of Bundler to install. Either none, 1, 2, latest or Gemfile.lock. The default tries Gemfile.lock and otherwise uses latest.'
13+
description: |
14+
Used by ruby/setup-ruby. The version of Bundler to install.
15+
See https://github.com/ruby/setup-ruby/blob/master/README.md.
1116
required: false
1217
default: 'default'
1318
bundler-cache:
14-
description: 'Used by ruby/setup-ruby. Run "bundle install", and cache the result automatically. Either true or false.'
19+
description: |
20+
Used by ruby/setup-ruby. Run 'bundle install', and cache the result automatically.
21+
See https://github.com/ruby/setup-ruby/blob/master/README.md.
1522
required: false
1623
default: 'false'
1724
working-directory:
18-
description: 'Used by ruby/setup-ruby. The working directory to use for resolving paths for .ruby-version, .tool-versions and Gemfile.lock.'
25+
description: |
26+
Used by ruby/setup-ruby. The working directory to use for resolving paths for
27+
.ruby-version, .tool-versions and Gemfile.lock.
28+
See https://github.com/ruby/setup-ruby/blob/master/README.md.
1929
required: false
2030
default: '.'
31+
cache-version:
32+
description: |
33+
Used by ruby/setup-ruby. Arbitrary string that will be added to the cache key
34+
of the bundler cache. Set or change it if you need to invalidate the cache.
35+
See https://github.com/ruby/setup-ruby/blob/master/README.md.
36+
required: false
37+
default: '0'
2138
apt-get:
2239
description: 'Ubuntu - install packages'
40+
required: false
2341
default: ''
2442
brew:
2543
description: 'macOS - install packages'
44+
required: false
2645
default: ''
2746
mingw:
2847
description: 'MinGW - install MSYS2 mingw64 packages'
48+
required: false
2949
default: ''
3050
msys2:
3151
description: 'MinGW - install MSYS2 msys2 packages'
52+
required: false
3253
default: ''
3354
mswin:
3455
description: 'mswin - install MSYS2 packages (mingw64 packages need prefix)'
56+
required: false
3557
default: ''
3658
choco:
3759
description: 'mswin - install Chocolatey packages'
60+
required: false
3861
default: ''
3962
vcpkg:
4063
description: 'mswin - install vcpkg packages'
64+
required: false
4165
default: ''
66+
setup-ruby-ref:
67+
description: |
68+
Base ruby-setup repository. It is executed before installing packages,
69+
and after if 'bundle install' is used. Only used for testing updates to
70+
ruby/setup-ruby. Changing this may run untrusted code.
71+
required: false
72+
default: 'ruby/setup-ruby/v1'
4273
runs:
4374
using: 'node12'
4475
main: 'dist/index.js'

0 commit comments

Comments
 (0)