README
¶
runs-on/action
RunsOn Action for magic caching, and more. This action is required if you are using the magic caching feature of RunsOn (extras=s3-cache job label).
Usage
jobs:
build:
runs-on: runs-on=${{ github.run_id }}/runner=2cpu-linux-x64/extras=s3-cache
steps:
- uses: runs-on/action@v1
- other steps
Options
show_env
Show all environment variables available to actions (used for debugging purposes).
jobs:
build:
runs-on: runs-on=${{ github.run_id }}/runner=2cpu-linux-x64/extras=s3-cache
steps:
- uses: runs-on/action@v1
with:
show_env: true
show_costs
Displays how much it cost to run that workflow job. Uses https://ec2-pricing.runs-on.com to get accurate data, for both on-demand and spot pricing across all regions and availability zones.
Beta: also compares with similar machine on GitHub.
Example output in the post-step:
| metric | value |
| ---------------------- | --------------- |
| Instance Type | m7i-flex.large |
| Instance Lifecycle | on-demand |
| Region | us-east-1 |
| Duration | 2.06 minutes |
| Cost | $0.0040 |
| GitHub equivalent cost | $0.0240 |
| Savings | $0.0200 (82.8%) |
metrics
Send additional metrics using CloudWatch agent.
Supported metrics:
| Metric Type | Available Metrics |
|---|---|
cpu |
usage_user, usage_system |
network |
bytes_recv, bytes_sent |
memory |
used_percent |
disk |
used_percent, inodes_used |
io |
io_time, reads, writes |
jobs:
build:
runs-on: runs-on=${{ github.run_id }}/runner=2cpu-linux-x64/extras=s3-cache
steps:
- uses: runs-on/action@v1
with:
metrics: cpu,network,memory,disk,io
The action will display live metrics with sparklines and charts in the post-execution summary.
Example output:
📊 CPU User:
100.0 ┤
87.5 ┤
75.0 ┤
62.5 ┤
50.0 ┤
37.5 ┤
25.0 ┤
12.5 ┼───────────────────────────────────────────────────────────
0.0 ┤
CPU User (Percent)
Stats: min:7.4 avg:8.3 max:8.8 Percent
📊 CPU System:
100.0 ┤
87.5 ┤
75.0 ┤
62.5 ┤
50.0 ┤
37.5 ┤
25.0 ┤ ╭─────────────╮ ╭───────────────
12.5 ┼───────╯ ╰─────────────────────╯
0.0 ┤
CPU System (Percent)
Stats: min:16.8 avg:18.7 max:20.7 Percent
📊 Network Received:
34314 ┼╮
31245 ┤╰╮
28175 ┤ ╰╮
25106 ┤ ╰─╮ ╭──╮
22036 ┤ ╰╮ ╭─╯ ╰╮
18967 ┤ ╰╮ ╭─╯ ╰─╮ ╭───╮
15898 ┤ ╰╮ ╭╯ ╰─╮ ╭──╯ ╰───╮
12828 ┤ ╰──╯ ╰╮ ╭──╯ ╰───────╮
9759 ┤ ╰─╯ ╰──────────
Network Received (Bytes)
Stats: min:9759.0 avg:16461.6 max:34314.0 Bytes
📊 Network Sent:
51281 ┼╮
46447 ┤╰╮
41614 ┤ ╰╮
36780 ┤ ╰╮
31946 ┤ ╰─╮
27113 ┤ ╰╮ ╭╮
22279 ┤ ╰╮ ╭────╯╰──╮ ╭─────╮
17446 ┤ ╰───╯ ╰──╮ ╭───╯ ╰──────╮
12612 ┤ ╰───╯ ╰──────────────
Network Sent (Bytes)
Stats: min:12612.0 avg:22532.8 max:51281.0 Bytes
📊 Memory Used:
100.0 ┤
87.5 ┤
75.0 ┤
62.5 ┤
50.0 ┤
Stats: min:504.0 avg:948.6 max:1281.0 ms
📊 Disk Reads:
25.0 ┼╮
21.9 ┤╰╮
18.8 ┤ ╰─╮
15.6 ┤ ╰╮
12.5 ┤ ╰╮
9.4 ┤ ╰╮ ╭
6.3 ┤ ╰╮ ╭──╯
3.2 ┤ ╰────╮ ╭───────╮ ╭──╯
0.0 ┤ ╰────────╯ ╰──────────────────────╯
Disk Reads (Ops/s)
Stats: min:0.0 avg:5.0 max:25.0 Ops/s
📊 Disk Writes:
5973 ┤ ╭╮
5500 ┤ ╭╯╰╮
5028 ┼╮ ╭╯ ╰╮ ╭───╮ ╭
4555 ┤╰╮ ╭╯ ╰╮ ╭──╯ ╰─╮ ╭─╯
4083 ┤ ╰╮ ╭╯ ╰─╮ ╭──╯ ╰╮ ╭─╯
3610 ┤ ╰─╮ ╭╯ ╰╮ ╭──╯ ╰─╮ ╭─╯
3138 ┤ ╰╮ ╭╯ ╰╮ ╭───╯ ╰───╯
2665 ┤ ╰╮ ╭╯ ╰─╯
2193 ┤ ╰──╯
Disk Writes (Ops/s)
Stats: min:2040.0 avg:4180.9 max:6026.0 Ops/s
sccache
Only available for Linux runners.
Configures sccache so that you can cache the compilation of C/C++ code, Rust, as well as NVIDIA's CUDA.
The only parameter it can take for now is s3, which will auto-configure the S3 cache backend for sccache, using the RunsOn S3 cache bucket that comes for free (with crazy speed and unlimited storage) with your RunsOn installation.
Example:
jobs:
build:
runs-on: runs-on=${{ github.run_id }}/runner=2cpu-linux-x64/extras=s3-cache
steps:
- uses: runs-on/action@v1
with:
sccache: s3
- uses: mozilla-actions/sccache-action@v0.0.9
- run: # your slow rust compilation
What this does under the hood is the equivalent of:
echo "SCCACHE_GHA_ENABLED=false" >> $GITHUB_ENV
echo "SCCACHE_BUCKET=${{ env.RUNS_ON_S3_BUCKET_CACHE}}" >> $GITHUB_ENV
echo "SCCACHE_REGION=${{ env.RUNS_ON_AWS_REGION}}" >> $GITHUB_ENV
echo "SCCACHE_S3_KEY_PREFIX=cache/sccache" >> $GITHUB_ENV
echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
Development
Make your source code changes in a commit, then push the updated binaries and JS files in a separate commit:
make release
Future work
This action will probably host a few other features such as:
- enabling/disabling SSM agent ?
Documentation
¶
There is no documentation for this package.
Source Files
Directories