ruby/setup-ruby
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve the README

Browse Source
This commit is contained in:
Benoit Daloze
2020-01-05 12:55:52 +01:00
parent d9cd49386b
commit a90d45f642
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -6
View File
@@ -2,7 +2,10 @@
This action downloads a prebuilt ruby and adds it to `$PATH`. This action downloads a prebuilt ruby and adds it to `$PATH`.
## Supported Versions It is very efficient and takes about 5 seconds to download, extract and add the given Ruby to `$PATH`.
No extra packages need to be installed.
### Supported Versions
This action currently supports these versions of MRI, JRuby and TruffleRuby: This action currently supports these versions of MRI, JRuby and TruffleRuby:
@@ -18,7 +21,7 @@ for the always up-to-date list of available Ruby versions.
Note that Ruby 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life, Note that Ruby 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life,
which means Ruby 2.3 is unmaintained and considered insecure. which means Ruby 2.3 is unmaintained and considered insecure.
## Platforms ### Supported Platforms
The action works for the `ubuntu-16.04`, `ubuntu-18.04` and `macos-latest` GitHub-hosted runners. The action works for the `ubuntu-16.04`, `ubuntu-18.04` and `macos-latest` GitHub-hosted runners.
`windows-latest` is not yet supported. `windows-latest` is not yet supported.
@@ -94,10 +97,6 @@ jobs:
- run: ruby -v - run: ruby -v
``` ```
## Efficiency
It takes about 5 seconds to setup the given Ruby.
## Limitations ## Limitations
* Currently does not work on Windows since the builder doesn't build on Windows. * Currently does not work on Windows since the builder doesn't build on Windows.