Skip to content

Commit b5e583a

Browse files
committed
Update documentation about TravisCI
PullRequest: truffleruby/540
2 parents 8f64f76 + 16bba36 commit b5e583a

File tree

2 files changed

+24
-32
lines changed

2 files changed

+24
-32
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,23 @@ There are three ways to install TruffleRuby:
2121
using a Ruby manager.
2222

2323
* Using the [standalone distribution](doc/user/standalone-distribution.md)
24-
as a simple binary tarball. This distribution can also be used for
24+
as a simple binary tarball. This distribution is also useful for
2525
[testing TruffleRuby in CI](doc/user/standalone-distribution.md).
26+
On [TravisCI](https://docs.travis-ci.com/user/languages/ruby#truffleruby), you can simply use:
27+
```yaml
28+
language: ruby
29+
rvm:
30+
- truffleruby
31+
```
2632
2733
You can use `gem` to install Gems as normal.
2834

2935
You can also build TruffleRuby from source, see the
3036
[building instructions](doc/contributor/workflow.md), and using
3137
[Docker](doc/contributor/docker.md).
3238

39+
Please report any issue you might find on [GitHub](https://github.com/oracle/truffleruby/issues).
40+
3341
## Aim
3442

3543
TruffleRuby aims to:

doc/user/standalone-distribution.md

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,23 @@ truffleruby-VERSION-linux-amd64.tar.gz
1616
truffleruby-VERSION-macos-amd64.tar.gz
1717
```
1818

19+
## Testing TruffleRuby in TravisCI
20+
21+
TruffleRuby is now integrated in TravisCI.
22+
Just add `truffleruby` in the build matrix, such as:
23+
24+
```yaml
25+
language: ruby
26+
rvm:
27+
- 2.6.0
28+
- truffleruby
29+
```
30+
31+
See https://docs.travis-ci.com/user/languages/ruby#truffleruby for details.
32+
Please [report](https://github.com/oracle/truffleruby/issues) any issue you might find while testing with TruffleRuby.
33+
1934
## Testing TruffleRuby in CI
2035
21-
The standalone distributions are also useful for testing, for instance to test
22-
TruffleRuby in your continuous integration system. If you use TravisCI,
23-
[see below](#testing-truffleruby-in-travisci).
2436
If you use another continuous integration system, you can follow these
2537
instructions to run TruffleRuby in CI.
2638
@@ -45,34 +57,6 @@ TruffleRuby uses the correct `GEM_HOME` and `GEM_PATH`. This is the reason for
4557
See [Using TruffleRuby without a Ruby manager](ruby-managers.md#using-truffleruby-without-a-ruby-manager)
4658
for details.
4759

48-
## Testing TruffleRuby in TravisCI
49-
50-
For TravisCI, we
51-
[plan to integrate](https://github.com/travis-ci/travis-ci/issues/9803)
52-
directly so one could just use `rvm: truffleruby` in the build matrix.
53-
However, this is not complete yet. In the meantime, the following example
54-
configuration can be used.
55-
56-
Set `TRUFFLERUBY_VERSION` to the latest TruffleRuby version from
57-
[GitHub releases](https://github.com/oracle/truffleruby/releases).
58-
59-
```yaml
60-
script:
61-
- bundle exec rspec
62-
matrix:
63-
include:
64-
- rvm: 2.5.1
65-
- name: TruffleRuby
66-
rvm: system
67-
install:
68-
- export TRUFFLERUBY_VERSION=<desired_version>
69-
- curl -L https://github.com/oracle/truffleruby/releases/download/vm-$TRUFFLERUBY_VERSION/truffleruby-$TRUFFLERUBY_VERSION-linux-amd64.tar.gz | tar xz
70-
- export PATH="$PWD/truffleruby-$TRUFFLERUBY_VERSION-linux-amd64/bin:$PATH"
71-
- $PWD/truffleruby-$TRUFFLERUBY_VERSION-linux-amd64/lib/truffle/post_install_hook.sh
72-
- gem install bundler
73-
- bundle install
74-
```
75-
7660
## Dependencies
7761

7862
[TruffleRuby's dependencies](../../README.md#dependencies) need to be installed

0 commit comments

Comments
 (0)