Skip to content

Commit 1b03b75

Browse files
MSP-GregMSP-Greg
committed
Better doc of inputs, update dependencies, etc
1 parent 4fc46d3 commit 1b03b75

12 files changed

+432
-120
lines changed

‎.github/workflows/dependabot.yml

-15
This file was deleted.

‎.github/workflows/ruby.yml

+9-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ jobs:
99
strategy:
1010
fail-fast: false
1111
matrix:
12-
os: [ ubuntu-20.04, ubuntu-18.04, macos-10.15 ]
13-
ruby: [ ruby-head, '3.0', 2.7, 2.5, 2.2, jruby, truffleruby ]
12+
os: [ ubuntu-20.04, ubuntu-18.04, macos-11, macos-10.15 ]
13+
ruby: [ ruby-head, 3.1, '3.0', 2.7, 2.5, 2.2, jruby, truffleruby ]
1414
runs-on: ${{ matrix.os }}
1515
steps:
1616
- name: Checkout
@@ -74,6 +74,13 @@ jobs:
7474
if ('${{ matrix.ruby }}' -ge '2.4') {
7575
ridk version
7676
}
77+
78+
- name: update RubyGems for Ruby 2.4 & 2.5
79+
# Included RubyGems doesn't work with required_ruby_version
80+
if: (matrix.ruby >= '2.4') && (matrix.ruby < '2.6')
81+
run: gem update --system --no-document
82+
timeout-minutes: 5
83+
7784
- name: gem install openssl
7885
if: (matrix.ruby >= '2.4') && (matrix.ruby <= '3.2')
7986
run: gem install openssl -N

‎README.md

+37-41
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
[ruby/setup-ruby]:https://github.com/ruby/setup-ruby
2+
[README]:https://github.com/ruby/setup-ruby/blob/master/README.md
3+
[action.yml]:https://github.com/ruby/setup-ruby/blob/master/action.yml
24

35
# setup-ruby-pkgs
46

@@ -11,28 +13,27 @@ The action's inputs are shown below:
1113
```yaml
1214
- uses: MSP-Greg/setup-ruby-pkgs@v1
1315
with:
14-
ruby-version:
15-
bundler:
16-
apt: # Ubuntu
17-
brew: # macOS
18-
mingw: # Windows mingw / mswin
19-
msys2: # mingw
20-
mswin: # Windows mswin
21-
choco: # mswin
22-
vcpkg: # mswin
16+
ruby-version: # passed to ruby/setup-ruby
17+
bundler: # " " " " "
18+
bundler-cache: # " " " " "
19+
cache-version: # " " " " "
20+
rubygems: # " " " " "
21+
working-directory: # " " " " "
22+
apt: # Ubuntu
23+
brew: # macOS
24+
mingw: # Windows mingw / mswin /ucrt
25+
msys2: # mingw / mswin /ucrt
26+
mswin: # Windows mswin
27+
choco: # mswin
28+
vcpkg: # mswin
2329
```
2430
2531
## Input Information
2632
27-
All inputs are optional.
28-
29-
### ruby-version:
30-
31-
Installs the Ruby version using the code from [ruby/setup-ruby]. The available versions can be found in its [README](https://github.com/ruby/setup-ruby/blob/master/README.md#supported-versions).
33+
Information on inputs passed to [ruby/setup-ruby] is contained in its [README] and
34+
[action.yml] files.
3235
33-
### bundler:
34-
35-
Installs Bundler using the code from [ruby/setup-ruby].
36+
All inputs are optional.
3637
3738
### apt: (Ubuntu)
3839
@@ -49,34 +50,29 @@ List of packages to install. Space delimited. Special options are `_update_` an
4950

5051
### mingw: (Windows)
5152

52-
<dl>
53-
<dt><b>Ruby 2.4 & later</b></dt>
54-
<dd>List of MSYS2 MinGW packages to install.
55-
Space delimited. The package prefix (<code>mingw-w64-x86_64-</code>) is not required.<br/>If <code>_upgrade_</code> is included in the input, all packages needed by the gcc tools are updated.<br/>If <code>openssl</code> is included, an appropriate package will be installed.
56-
</dd>
57-
<dt><b>Ruby 2.3 & earlier</b></dt>
58-
<dd>The following DevKit packages are available:
59-
<ul>
60-
<li>libffi-3.2.1</li>
61-
<li>openssl-1.0.2j</li>
62-
<li>ragel-6.7</li>
63-
<li>sqlite-3.7.15.2 (sqlite3)</li>
64-
<li>zlib-1.2.8</li>
65-
</ul>
66-
</dd>
67-
<dt><b>Ruby mswin</b></dt>
68-
<dd>If <code>openssl</code> is included, it will be installed for mswin as a convenience.<br/>Likewise, if <code>ragel</code> is included, the MSYS2 ragel package will be installed.
53+
* **Ruby 2.4 & later**<br/>
54+
List of MSYS2 MinGW packages to install.<br/>
55+
Space delimited. The package prefix (`mingw-w64-x86_64-` or `mingw-w64-ucrt-x86_64-`) is not required.<br/>If `_upgrade_` is included in the input, all packages needed by the gcc tools are updated.<br/>If `openssl` is included, an appropriate package will be installed.
56+
57+
* **Ruby 2.3 & earlier**<br/>
58+
The following DevKit packages are available:<br/>
59+
* libffi-3.2.1
60+
* openssl-1.0.2j
61+
* ragel-6.7
62+
* sqlite-3.7.15.2 (sqlite3)</li>
63+
* zlib-1.2.8
64+
65+
* **Ruby mswin**<br/>
66+
If `openssl` is included, it will be installed for mswin as a convenience.<br/>Likewise, if `ragel` is included, the MSYS2 ragel package will be installed.
6967
</dl>
7068

7169
### msys2: (Windows)
7270

73-
<dl>
74-
<dt><b>Ruby 2.4 & later</b></dt>
75-
<dd>List of MSYS2 packages to install. Space delimited. These are command line utilities, and are rarely needed.
76-
</dd>
77-
<dt><b>Ruby 2.3 & earlier</b></dt>
78-
<dd>No action, as no utilities are available for the older MSYS/DevKit.</dd>
79-
</dl>
71+
* **Ruby 2.4 & later**<br/>
72+
List of MSYS2 packages to install. Space delimited. These are command line utilities, and are rarely needed.
73+
74+
* **Ruby 2.3 & earlier**<br/
75+
No action, as no utilities are available for the older MSYS/DevKit.</dd>
8076

8177
### mswin: (Windows)
8278

‎RELEASES.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# @MSP-Greg/setup-ruby-pkgs Releases
22

3+
### v1.30.2 - 2022-May-04
4+
- Improve input doc, update dependencies
5+
6+
### v1.30.1 - 2022-Jan-27
7+
- [mswin openssl - keep in Program Files](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/4fc46d3152)
8+
9+
### v1.30.0 - 2022-Jan-13
10+
- Updates for Windows ucrt builds
11+
12+
### v1.29.2 - 2021-Sep-09
13+
- [Add pkgconf to gcc packages](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/5f02b049d9)
14+
15+
### v1.29.1 - 2021-Jun-24
16+
- [Disable slow pacman disk space check](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/1cff2817ea)
17+
318
### v1.10.0
419
- [Update MSYS2 to 2020-05-20](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/b5d86ae)
520

‎Ruby_and_Windows.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
[MSYS2]:https://github.com/msys2
22
[ruby/setup-ruby]:https://github.com/ruby/setup-ruby
33

4+
**NOTE:** This doc is outdated. Updates regarding ucrt and mswin builds to follow.
5+
46
# Ruby and Windows
57

68
This document is intended to provide information on Windows Ruby builds that may help with Windows CI problems.
79

8-
Problems are most likely to occur with gems/repos that require compiling. They may also occur when installing dependencies that require compiling.
10+
Problems are most likely to occur with gems/repos (or their dependencies) that require compiling.
911

1012
Much of the below information is general, and may also help with users having problems locally.
1113

‎action.yml

+21-5
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,56 @@
1+
---
12
name: 'Setup Ruby Pkgs'
23
description: 'Cross platform action for setting up Ruby build environments. Runs ruby/setup-ruby, see input info'
34
author: 'MSP-Greg'
5+
# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
46
inputs:
7+
#————————————————————————————————————————— inputs used by ruby/setup-ruby
58
ruby-version:
69
description: |
710
Used by ruby/setup-ruby. Ruby version.
8-
See https://github.com/ruby/setup-ruby/blob/master/README.md.
11+
See https://github.com/ruby/setup-ruby/blob/master/README.md and
12+
https://github.com/ruby/setup-ruby/blob/master/action.yml.
913
A value of 'none' will bypass running ruby/setup-ruby.
1014
required: false
1115
default: 'default'
1216
bundler:
1317
description: |
1418
Used by ruby/setup-ruby. The version of Bundler to install.
15-
See https://github.com/ruby/setup-ruby/blob/master/README.md.
19+
See https://github.com/ruby/setup-ruby/blob/master/README.md and
20+
https://github.com/ruby/setup-ruby/blob/master/action.yml.
1621
required: false
1722
default: 'default'
1823
bundler-cache:
1924
description: |
2025
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.
26+
See https://github.com/ruby/setup-ruby/blob/master/README.md and
27+
https://github.com/ruby/setup-ruby/blob/master/action.yml.
2228
required: false
2329
default: 'false'
30+
rubygems:
31+
description: |
32+
Used by ruby/setup-ruby. Runs `gem update --system`.
33+
See https://github.com/ruby/setup-ruby/blob/master/README.md and
34+
https://github.com/ruby/setup-ruby/blob/master/action.yml.
35+
required: false
36+
default: 'default'
2437
working-directory:
2538
description: |
2639
Used by ruby/setup-ruby. The working directory to use for resolving paths for
2740
.ruby-version, .tool-versions and Gemfile.lock.
28-
See https://github.com/ruby/setup-ruby/blob/master/README.md.
41+
See https://github.com/ruby/setup-ruby/blob/master/README.md and
42+
https://github.com/ruby/setup-ruby/blob/master/action.yml.
2943
required: false
3044
default: '.'
3145
cache-version:
3246
description: |
3347
Used by ruby/setup-ruby. Arbitrary string that will be added to the cache key
3448
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.
49+
See https://github.com/ruby/setup-ruby/blob/master/README.md and
50+
https://github.com/ruby/setup-ruby/blob/master/action.yml.
3651
required: false
3752
default: '0'
53+
#————————————————————————————————————————— inputs used by this setup-ruby-pkgs
3854
apt-get:
3955
description: 'Ubuntu - install packages'
4056
required: false

0 commit comments

Comments
 (0)