Skip to content

Commit 6eccab6

Browse files
committed
readme: add self-hosted runners and container jobs
Running the action on a self-hosted runner or in a container job is supported since PR #45, but it requires a few additional steps. Let's describe them in the README.md file. Fixes #47
1 parent f54188f commit 6eccab6

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

+42-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ This action will set up [Tarantool](https://www.tarantool.io) environment and **
66

77
- When cached, it takes \~1-2s to finish.
88
- The first run takes \~40s.
9-
- Cache size is \~20MB.
10-
- Runs on GitHub-hosted `ubuntu-*` runners only.
9+
- Cache size is 20MB-30MB.
10+
- Runs on GitHub-hosted `ubuntu-*` runners.
11+
- Runs on Debian/Ubuntu self-hosted runners.
12+
- Runs inside Debian/Ubuntu container jobs.
1113

1214
# Usage
1315

@@ -47,6 +49,44 @@ steps:
4749
nightly-build: true
4850
```
4951
52+
### Self-hosted runners and container jobs
53+
54+
It requires an additional step to bring dependencies needed for the action
55+
itself. These dependencies are preinstalled on GitHub hosted runners, but a
56+
self-hosted runner and a docker image may miss them.
57+
58+
Configuring `apt-get` to skip recommended and suggested packages reduces the
59+
cache size from \~200MiB to \~30MiB.
60+
61+
```yaml
62+
jobs:
63+
myjob:
64+
runs-on: ubuntu-latest
65+
container:
66+
image: debian:bookworm
67+
68+
env:
69+
DEBIAN_FRONTEND: noninteractive
70+
71+
steps:
72+
- name: Configure apt-get
73+
run: |
74+
mkdir -p /etc/apt/apt.conf.d
75+
printf '%s\n%s\n' \
76+
'APT::Install-Recommends "false";' \
77+
'APT::Install-Suggests "false";' \
78+
> /etc/apt/apt.conf.d/no-recommends-no-suggests.conf
79+
80+
- name: Install setup-tarantool dependencies
81+
run: |
82+
apt-get -y update
83+
apt-get -y install sudo lsb-release gnupg ca-certificates rsync
84+
85+
- uses: tarantool/setup-tarantool@ab69f5679e6ea7e5872d9e0901f681587fd29be6
86+
with:
87+
tarantool-version: '2.11'
88+
```
89+
5090
# License
5191

5292
The scripts and documentation in this project are released under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)