From 4c00b61136a87d8a2f582b98868bf3c3b43d2baf Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Sun, 5 Jan 2020 13:03:07 +0100 Subject: [PATCH] Simplify the README --- README.md | 37 ++++++++----------------------------- 1 file changed, 8 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index fd04563..a73ceaa 100644 --- a/README.md +++ b/README.md @@ -48,35 +48,7 @@ jobs: ### Matrix -```yaml -name: My workflow -on: [push] -jobs: - test: - strategy: - fail-fast: false - matrix: - os: [ ubuntu-latest, macos-latest ] - ruby: [ 2.6, 2.7, jruby, truffleruby ] - runs-on: ${{ matrix.os }} - steps: - - uses: actions/checkout@v2 - - uses: eregon/use-ruby-action@master - with: - ruby-version: ${{ matrix.ruby }} - - run: ruby -v -``` - -### Supported Version Syntax - -* engine-version like `ruby-2.6.5` and `truffleruby-19.3.0` -* short version like `2.6`, automatically using the latest release matching that version (`2.6.5`) -* version only like `2.6.5`, assumes MRI for the engine -* engine only like `truffleruby`, uses the latest stable release of that implementation - -### All Stable Versions - -With that, we can test on all stable releases of MRI, JRuby and TruffleRuby with: +This matrix tests all stable releases of MRI, JRuby and TruffleRuby on Ubuntu and macOS. ```yaml name: My workflow @@ -97,6 +69,13 @@ jobs: - run: ruby -v ``` +### Supported Version Syntax + +* engine-version like `ruby-2.6.5` and `truffleruby-19.3.0` +* short version like `2.6`, automatically using the latest release matching that version (`2.6.5`) +* version only like `2.6.5`, assumes MRI for the engine +* engine only like `truffleruby`, uses the latest stable release of that implementation + ## Limitations * Currently does not work on Windows since the builder doesn't build on Windows.