Skip to content
This repository was archived by the owner on Feb 9, 2021. It is now read-only.

Commit cc30ef3

Browse files
committed
Improve description based on feedback
1 parent 26cdcd0 commit cc30ef3

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@
44
<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>
55
</p>
66

7-
This action sets up Ruby for use in actions by adding a version of Ruby already existing in the toolcache to the PATH.
7+
This action sets up Ruby for use in actions by adding to the `PATH` a version of Ruby already existing in the toolcache.
8+
The toolcache is the set of tools preinstalled in [virtual environments](https://github.com/actions/virtual-environments).
89

910
This action currently only supports versions of Ruby in the toolcache.
1011
See [this list](https://github.com/actions/virtual-environments/blob/master/images/linux/Ubuntu1804-README.md) for the available Ruby versions.
12+
Note that the list might not always reflect the current versions as changes are rolled out over several days.
1113
The action will fail if no matching versions are found.
1214

13-
Because versions in the toolcache are updated over time, it is necessary to use a version range such as `2.6.x` and not exact versions.
15+
Because versions in the toolcache are updated over time, it is **necessary to use a version range** such as `2.6.x` and not exact versions.
1416

15-
If you are looking for using exact versions (e.g., `2.6.5`) of Ruby,
17+
If you are looking for using exact versions (e.g., `2.6.5`) of Ruby, or to use JRuby or TruffleRuby,
1618
please take a look at other actions such as [use-ruby-action](https://github.com/eregon/use-ruby-action).
1719
Note that there are [plans](https://github.com/actions/setup-ruby/issues/44) to support installing prebuilt Rubies with this action in the future.
1820

0 commit comments

Comments
 (0)