Skip to content

Commit 03b3d5e

Browse files
authored
Add readme and license (#5)
1 parent 0105f29 commit 03b3d5e

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
The MIT License (MIT)
3+
4+
Copyright (c) 2018 GitHub, Inc. and contributors
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in
14+
all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22+
THE SOFTWARE.

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Setup Tarantool
2+
3+
This action will set up [Tarantool](https://www.tarantool.io) environment and **cache the packages**.
4+
5+
- When cached, it takes \~1-2s to finish.
6+
- The first run takes \~40s.
7+
- Cache size is \~20MB.
8+
- Runs on `ubuntu-*` only.
9+
10+
# Usage
11+
12+
### Basic
13+
14+
```yaml
15+
steps:
16+
- uses: actions/checkout@v2
17+
- uses: rosik/setup-tarantool@v1
18+
with:
19+
tarantool-version: '2.5'
20+
- run: tarantoolctl rocks make
21+
```
22+
23+
### Custom cache key
24+
25+
By default, the action caches installed apt packages with the key:
26+
27+
```tarantool-setup-${tarantool-version}-${ubuntu-version}```
28+
29+
If you need to drop the cache, it's customizable:
30+
31+
```yaml
32+
steps:
33+
- uses: rosik/setup-tarantool@v1
34+
with:
35+
tarantool-version: 2.5
36+
cache-key: some-other-key
37+
```
38+
39+
# License
40+
41+
The scripts and documentation in this project are released under the [MIT License](LICENSE).
42+
43+
# Contributions
44+
45+
Contributions are welcome! Just open an issue or send a pull request.

0 commit comments

Comments
 (0)