Skip to content

Commit 0e31c0e

Browse files
kojix2kojix2
authored
Format README.md and ci.yml (#337)
1 parent bfbc967 commit 0e31c0e

File tree

2 files changed

+93
-94
lines changed

2 files changed

+93
-94
lines changed

‎.github/workflows/ci.yml

+85-85
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ name: CI
33
on:
44
push:
55
branches:
6-
- master
6+
- master
77
pull_request:
88
types:
9-
- opened
10-
- synchronize
11-
- reopened
9+
- opened
10+
- synchronize
11+
- reopened
1212

1313
jobs:
1414
ubuntu:
@@ -19,107 +19,107 @@ jobs:
1919
fail-fast: false
2020
matrix:
2121
os:
22-
- ubuntu-latest
22+
- ubuntu-latest
2323
ruby:
24-
- "3.3"
25-
- "3.2"
26-
- "3.1"
27-
- "3.0"
28-
- "2.7"
29-
- "2.6"
30-
- "2.5"
31-
- debug
24+
- "3.3"
25+
- "3.2"
26+
- "3.1"
27+
- "3.0"
28+
- "2.7"
29+
- "2.6"
30+
- "2.5"
31+
- debug
3232

3333
steps:
34-
- uses: actions/checkout@v3
35-
with:
36-
fetch-depth: 1
37-
38-
- uses: ruby/setup-ruby@v1
39-
with:
40-
ruby-version: ${{ matrix.ruby }}
41-
42-
- run: rake build
43-
44-
- name: Install irb for old Ruby
45-
if: |
46-
matrix.ruby == '2.5' ||
47-
matrix.ruby == '2.4' ||
48-
matrix.ruby == '2.3'
49-
run: |
50-
cat <<GEMFILE > Gemfile.irb
51-
source 'https://rubygems.org'
52-
gem 'irb'
53-
GEMFILE
54-
BUNDLE_GEMFILE=Gemfile.irb bundle install --jobs 4 --retry 3
55-
56-
- run: gem install pkg/*.gem
57-
58-
- run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
59-
env:
60-
IRUBY_SESSION_ADAPTER: ffi-rzmq
61-
62-
- name: Install requirements on ubuntu
63-
run: |
64-
sudo apt update
65-
sudo apt install -y --no-install-recommends \
66-
libczmq-dev \
67-
python3 \
68-
python3-pip \
69-
python3-setuptools
70-
sudo pip3 install wheel
71-
sudo pip3 install -r ci/requirements.txt
72-
73-
- run: bundle install --jobs 4 --retry 3
74-
75-
- name: Run tests
76-
env:
77-
PYTHON: python3
78-
ADAPTERS: cztop ffi-rzmq
79-
run: |
80-
for adapter in $ADAPTERS; do
81-
export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter
82-
bundle exec rake test TESTOPTS="-v"
83-
done
34+
- uses: actions/checkout@v3
35+
with:
36+
fetch-depth: 1
37+
38+
- uses: ruby/setup-ruby@v1
39+
with:
40+
ruby-version: ${{ matrix.ruby }}
41+
42+
- run: rake build
43+
44+
- name: Install irb for old Ruby
45+
if: |
46+
matrix.ruby == '2.5' ||
47+
matrix.ruby == '2.4' ||
48+
matrix.ruby == '2.3'
49+
run: |
50+
cat <<GEMFILE > Gemfile.irb
51+
source 'https://rubygems.org'
52+
gem 'irb'
53+
GEMFILE
54+
BUNDLE_GEMFILE=Gemfile.irb bundle install --jobs 4 --retry 3
55+
56+
- run: gem install pkg/*.gem
57+
58+
- run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
59+
env:
60+
IRUBY_SESSION_ADAPTER: ffi-rzmq
61+
62+
- name: Install requirements on ubuntu
63+
run: |
64+
sudo apt update
65+
sudo apt install -y --no-install-recommends \
66+
libczmq-dev \
67+
python3 \
68+
python3-pip \
69+
python3-setuptools
70+
sudo pip3 install wheel
71+
sudo pip3 install -r ci/requirements.txt
72+
73+
- run: bundle install --jobs 4 --retry 3
74+
75+
- name: Run tests
76+
env:
77+
PYTHON: python3
78+
ADAPTERS: cztop ffi-rzmq
79+
run: |
80+
for adapter in $ADAPTERS; do
81+
export IRUBY_TEST_SESSION_ADAPTER_NAME=$adapter
82+
bundle exec rake test TESTOPTS="-v"
83+
done
8484
8585
windows:
8686
name: Windows
8787
runs-on: windows-latest
8888

8989
steps:
90-
- uses: actions/checkout@v3
91-
with:
92-
fetch-depth: 1
90+
- uses: actions/checkout@v3
91+
with:
92+
fetch-depth: 1
9393

94-
- uses: ruby/setup-ruby@v1
95-
with:
96-
ruby-version: "3.0"
94+
- uses: ruby/setup-ruby@v1
95+
with:
96+
ruby-version: "3.0"
9797

98-
- run: rake build
98+
- run: rake build
9999

100-
- run: gem install pkg/*.gem
100+
- run: gem install pkg/*.gem
101101

102-
- run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
103-
env:
104-
IRUBY_SESSION_ADAPTER: ffi-rzmq
102+
- run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
103+
env:
104+
IRUBY_SESSION_ADAPTER: ffi-rzmq
105105

106106
macos:
107107
name: macOS
108108
runs-on: macos-latest
109109

110110
steps:
111-
- uses: actions/checkout@v3
112-
with:
113-
fetch-depth: 1
111+
- uses: actions/checkout@v3
112+
with:
113+
fetch-depth: 1
114114

115-
- uses: ruby/setup-ruby@v1
116-
with:
117-
ruby-version: "3.0"
115+
- uses: ruby/setup-ruby@v1
116+
with:
117+
ruby-version: "3.0"
118118

119-
- run: rake build
119+
- run: rake build
120120

121-
- run: gem install pkg/*.gem
121+
- run: gem install pkg/*.gem
122122

123-
- run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
124-
env:
125-
IRUBY_SESSION_ADAPTER: ffi-rzmq
123+
- run: ruby -r iruby -e "p IRuby::SessionAdapter.select_adapter_class"
124+
env:
125+
IRUBY_SESSION_ADAPTER: ffi-rzmq

‎README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ IRuby is a Ruby kernel for [Jupyter project](http://try.jupyter.org/).
1010

1111
You can try IRuby with a sample notebook on Binder (the same link as the banner placed above):
1212

13-
https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb
13+
<https://mybinder.org/v2/gh/RubyData/binder/master?filepath=ruby-data.ipynb>
1414

1515
The following URL launches JupyterLab directly on Binder.
1616

17-
https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab
17+
<https://mybinder.org/v2/gh/RubyData/binder/master?filepath=../lab>
1818

1919
## Installation
2020

@@ -31,13 +31,12 @@ The following dependencies are optional.
3131

3232
* [Pry][Pry], if you want to use [Pry][Pry] instead of IRB for the code execution backend
3333

34-
3534
### Installing Jupyter Notebook and/or JupyterLab
3635

3736
See the official document to know how to install Jupyter Notebook and/or JupyterLab.
3837

39-
* https://jupyter.readthedocs.io/en/latest/install/notebook-classic.html
40-
* https://jupyter.readthedocs.io/en/latest/install.html
38+
* <https://jupyter.readthedocs.io/en/latest/install/notebook-classic.html>
39+
* <https://jupyter.readthedocs.io/en/latest/install.html>
4140

4241
### Ubuntu
4342

@@ -106,7 +105,7 @@ iruby register --force
106105

107106
### Docker
108107

109-
Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks).
108+
Try [RubyData Docker Stacks](https://github.com/RubyData/docker-stacks).
110109
Running jupyter notebook:
111110

112111
```shell
@@ -123,15 +122,15 @@ You can use Java classes in your IRuby notebook.
123122
After installation, make sure that your `env` is set up to use jruby.
124123

125124
```shell
126-
$ env ruby -v
125+
env ruby -v
127126
```
128127

129128
If you use RVM, it is enough to switch the current version to jruby.
130129

131130
If you have already used IRuby with a different version, you need to generate a new kernel:
132131

133132
```shell
134-
$ iruby register --force
133+
iruby register --force
135134
```
136135

137136
### Install the development version of IRuby
@@ -182,7 +181,7 @@ Contributions to IRuby are very welcome.
182181

183182
To former contributors
184183

185-
In February 2021, [IRuby became the canonical repository](https://github.com/SciRuby/iruby/issues/285) and is no longer a fork from [minrk/iruby](https://github.com/minrk/iruby). Please fork from this repository again before making pull requests.
184+
In February 2021, [IRuby became the canonical repository](https://github.com/SciRuby/iruby/issues/285) and is no longer a fork from [minrk/iruby](https://github.com/minrk/iruby). Please fork from this repository again before making pull requests.
186185

187186
## License
188187

0 commit comments

Comments
 (0)