d838e152a7
* Use more realistic versions. * `architecture` is not used for this action. * Remove redundant `name:` in example.
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
# setup-ruby
|
|
|
|
<p align="left">
|
|
<a href="https://github.com/actions/setup-ruby"><img alt="GitHub Actions status" src="https://github.com/actions/setup-ruby/workflows/Main%20workflow/badge.svg"></a>
|
|
</p>
|
|
|
|
This action sets up a ruby environment for use in actions by:
|
|
|
|
- optionally installing a version of ruby and adding to PATH. Note that this action only uses versions of Ruby already installed in the cache. The action will fail if no matching versions are found.
|
|
- registering problem matchers for error output
|
|
|
|
# Usage
|
|
|
|
See [action.yml](action.yml)
|
|
|
|
Basic:
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- uses: actions/setup-ruby@v1
|
|
with:
|
|
ruby-version: '2.6.x' # Version range or exact version of a Ruby version to use, using semvers version range syntax.
|
|
- run: ruby hello.rb
|
|
```
|
|
|
|
Matrix Testing:
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-16.04
|
|
strategy:
|
|
matrix:
|
|
ruby: [ '2.5.x', '2.6.x' ]
|
|
name: Ruby ${{ matrix.ruby }} sample
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- uses: actions/setup-ruby@v1
|
|
with:
|
|
ruby-version: ${{ matrix.ruby }}
|
|
- run: ruby hello.rb
|
|
```
|
|
|
|
# License
|
|
|
|
The scripts and documentation in this project are released under the [MIT License](LICENSE)
|
|
|
|
# Contributions
|
|
|
|
Contributions are welcome! See [Contributor's Guide](docs/contributors.md)
|