Update README.md

This commit is contained in:
Danny McCormick
2019-07-17 11:01:48 -04:00
committed by GitHub
parent 207b0721f1
commit 3125a78d41

View File

@@ -1,4 +1,39 @@
# @actions/setup-ruby
# setup-ruby
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
actions:
- uses: actions/setup-ruby@latest
with:
version: 2.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:
strategy:
matrix:
ruby: [ 2.x, 3.x ]
name: Ruby ${{ matrix.ruby }} sample
actions:
- name: Setup ruby
uses: actions/setup-ruby@latest
with:
version: ${{ matrix.ruby }}
architecture: x64
- run: ruby hello.rb
```
# License