Skip to content

Commit

Permalink
Better doc of inputs, update dependencies, etc
Browse files Browse the repository at this point in the history
  • Loading branch information
MSP-Greg committed May 4, 2022
1 parent 4fc46d3 commit 1b03b75
Show file tree
Hide file tree
Showing 12 changed files with 432 additions and 120 deletions.
15 changes: 0 additions & 15 deletions .github/workflows/dependabot.yml

This file was deleted.

11 changes: 9 additions & 2 deletions .github/workflows/ruby.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ jobs:
strategy:
fail-fast: false
matrix:
os: [ ubuntu-20.04, ubuntu-18.04, macos-10.15 ]
ruby: [ ruby-head, '3.0', 2.7, 2.5, 2.2, jruby, truffleruby ]
os: [ ubuntu-20.04, ubuntu-18.04, macos-11, macos-10.15 ]
ruby: [ ruby-head, 3.1, '3.0', 2.7, 2.5, 2.2, jruby, truffleruby ]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
Expand Down Expand Up @@ -74,6 +74,13 @@ jobs:
if ('${{ matrix.ruby }}' -ge '2.4') {
ridk version
}
- name: update RubyGems for Ruby 2.4 & 2.5
# Included RubyGems doesn't work with required_ruby_version
if: (matrix.ruby >= '2.4') && (matrix.ruby < '2.6')
run: gem update --system --no-document
timeout-minutes: 5

- name: gem install openssl
if: (matrix.ruby >= '2.4') && (matrix.ruby <= '3.2')
run: gem install openssl -N
78 changes: 37 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[ruby/setup-ruby]:https://github.com/ruby/setup-ruby
[README]:https://github.com/ruby/setup-ruby/blob/master/README.md
[action.yml]:https://github.com/ruby/setup-ruby/blob/master/action.yml

# setup-ruby-pkgs

Expand All @@ -11,28 +13,27 @@ The action's inputs are shown below:
```yaml
- uses: MSP-Greg/setup-ruby-pkgs@v1
with:
ruby-version:
bundler:
apt: # Ubuntu
brew: # macOS
mingw: # Windows mingw / mswin
msys2: # mingw
mswin: # Windows mswin
choco: # mswin
vcpkg: # mswin
ruby-version: # passed to ruby/setup-ruby
bundler: # " " " " "
bundler-cache: # " " " " "
cache-version: # " " " " "
rubygems: # " " " " "
working-directory: # " " " " "
apt: # Ubuntu
brew: # macOS
mingw: # Windows mingw / mswin /ucrt
msys2: # mingw / mswin /ucrt
mswin: # Windows mswin
choco: # mswin
vcpkg: # mswin
```

## Input Information

All inputs are optional.

### ruby-version:

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).
Information on inputs passed to [ruby/setup-ruby] is contained in its [README] and
[action.yml] files.

### bundler:

Installs Bundler using the code from [ruby/setup-ruby].
All inputs are optional.

### apt: (Ubuntu)

Expand All @@ -49,34 +50,29 @@ List of packages to install. Space delimited. Special options are `_update_` an

### mingw: (Windows)

<dl>
<dt><b>Ruby 2.4 & later</b></dt>
<dd>List of MSYS2 MinGW packages to install.
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.
</dd>
<dt><b>Ruby 2.3 & earlier</b></dt>
<dd>The following DevKit packages are available:
<ul>
<li>libffi-3.2.1</li>
<li>openssl-1.0.2j</li>
<li>ragel-6.7</li>
<li>sqlite-3.7.15.2 (sqlite3)</li>
<li>zlib-1.2.8</li>
</ul>
</dd>
<dt><b>Ruby mswin</b></dt>
<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.
* **Ruby 2.4 & later**<br/>
List of MSYS2 MinGW packages to install.<br/>
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.

* **Ruby 2.3 & earlier**<br/>
The following DevKit packages are available:<br/>
* libffi-3.2.1
* openssl-1.0.2j
* ragel-6.7
* sqlite-3.7.15.2 (sqlite3)</li>
* zlib-1.2.8

* **Ruby mswin**<br/>
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.
</dl>

### msys2: (Windows)

<dl>
<dt><b>Ruby 2.4 & later</b></dt>
<dd>List of MSYS2 packages to install. Space delimited. These are command line utilities, and are rarely needed.
</dd>
<dt><b>Ruby 2.3 & earlier</b></dt>
<dd>No action, as no utilities are available for the older MSYS/DevKit.</dd>
</dl>
* **Ruby 2.4 & later**<br/>
List of MSYS2 packages to install. Space delimited. These are command line utilities, and are rarely needed.

* **Ruby 2.3 & earlier**<br/
No action, as no utilities are available for the older MSYS/DevKit.</dd>

### mswin: (Windows)

Expand Down
15 changes: 15 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# @MSP-Greg/setup-ruby-pkgs Releases

### v1.30.2 - 2022-May-04
- Improve input doc, update dependencies

### v1.30.1 - 2022-Jan-27
- [mswin openssl - keep in Program Files](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/4fc46d3152)

### v1.30.0 - 2022-Jan-13
- Updates for Windows ucrt builds

### v1.29.2 - 2021-Sep-09
- [Add pkgconf to gcc packages](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/5f02b049d9)

### v1.29.1 - 2021-Jun-24
- [Disable slow pacman disk space check](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/1cff2817ea)

### v1.10.0
- [Update MSYS2 to 2020-05-20](https://github.com/MSP-Greg/setup-ruby-pkgs/commit/b5d86ae)

Expand Down
4 changes: 3 additions & 1 deletion Ruby_and_Windows.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
[MSYS2]:https://github.com/msys2
[ruby/setup-ruby]:https://github.com/ruby/setup-ruby

**NOTE:** This doc is outdated. Updates regarding ucrt and mswin builds to follow.

# Ruby and Windows

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

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

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

Expand Down
26 changes: 21 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,56 @@
---
name: 'Setup Ruby Pkgs'
description: 'Cross platform action for setting up Ruby build environments. Runs ruby/setup-ruby, see input info'
author: 'MSP-Greg'
# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
inputs:
#————————————————————————————————————————— inputs used by ruby/setup-ruby
ruby-version:
description: |
Used by ruby/setup-ruby. Ruby version.
See https://github.com/ruby/setup-ruby/blob/master/README.md.
See https://github.com/ruby/setup-ruby/blob/master/README.md and
https://github.com/ruby/setup-ruby/blob/master/action.yml.
A value of 'none' will bypass running ruby/setup-ruby.
required: false
default: 'default'
bundler:
description: |
Used by ruby/setup-ruby. The version of Bundler to install.
See https://github.com/ruby/setup-ruby/blob/master/README.md.
See https://github.com/ruby/setup-ruby/blob/master/README.md and
https://github.com/ruby/setup-ruby/blob/master/action.yml.
required: false
default: 'default'
bundler-cache:
description: |
Used by ruby/setup-ruby. Run 'bundle install', and cache the result automatically.
See https://github.com/ruby/setup-ruby/blob/master/README.md.
See https://github.com/ruby/setup-ruby/blob/master/README.md and
https://github.com/ruby/setup-ruby/blob/master/action.yml.
required: false
default: 'false'
rubygems:
description: |
Used by ruby/setup-ruby. Runs `gem update --system`.
See https://github.com/ruby/setup-ruby/blob/master/README.md and
https://github.com/ruby/setup-ruby/blob/master/action.yml.
required: false
default: 'default'
working-directory:
description: |
Used by ruby/setup-ruby. The working directory to use for resolving paths for
.ruby-version, .tool-versions and Gemfile.lock.
See https://github.com/ruby/setup-ruby/blob/master/README.md.
See https://github.com/ruby/setup-ruby/blob/master/README.md and
https://github.com/ruby/setup-ruby/blob/master/action.yml.
required: false
default: '.'
cache-version:
description: |
Used by ruby/setup-ruby. Arbitrary string that will be added to the cache key
of the bundler cache. Set or change it if you need to invalidate the cache.
See https://github.com/ruby/setup-ruby/blob/master/README.md.
See https://github.com/ruby/setup-ruby/blob/master/README.md and
https://github.com/ruby/setup-ruby/blob/master/action.yml.
required: false
default: '0'
#————————————————————————————————————————— inputs used by this setup-ruby-pkgs
apt-get:
description: 'Ubuntu - install packages'
required: false
Expand Down

0 comments on commit 1b03b75

Please sign in to comment.