Skip to content

Commit 694577f

Browse files
authored
Add config file to enable Buildomat CI for illumos (#6768)
## Motivation As described in #6763, Tokio compiles for the [illumos] operating system, but we don't presently have automated tests on illumos. We would like to add illumos CI jobs for Tokio using [Buildomat], a CI system which supports illumos. Buildomat CI jobs for Tokio will run on infrastructure contributed by Oxide Computer Company. In order for Buildomat to watch for commits to the repo, we must first add a configuration file in `.github/buildomat/config.toml` with the `enable = true` key. This config file must be present on the repo's main branch for Buildomat to enable builds for the repo. See [here] for details. ## Solution This branch adds a `.github/buildomat` directory containing a config file and a README summarizing what the configs in that directory are for, as well as documenting how to get help diagnosing illumos CI failures. This branch does *not* add scripts for actually running CI jobs on Buildomat. Since the config file must be present on the repo's main branch before Buildomat runs CI jobs for the repo, I'd like to merge the config file separately from the actual build scripts. This way, I can actually have the build jobs run on the PR that adds them, making it easier to ensure everything is working correctly before merging. Closes #6766, which is obsoleted by this branch. [illumos]: https://www.illumos.org/ [Buildomat]: https://github.com/oxidecomputer/ [here]: https://github.com/oxidecomputer/buildomat/blob/main/README.md#per-repository-configuration
1 parent 1781906 commit 694577f

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

.github/buildomat/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Buildomat illumos CI
2+
3+
This directory contains CI configurations for the [illumos] operating system.
4+
Tokio's illumos CI jobs are run using [Buildomat], a CI system developed by
5+
Oxide Computer, which supports illumos. See [the Buildomat README] for more
6+
details.
7+
8+
## illumos-Specific CI Failures
9+
10+
If your pull request's CI build fails on illumos, and you aren't able to easily
11+
reproduce the failure on other operating systems, don't worry! The
12+
[tokio-rs/illumos] team is responsible for maintaining Tokio's illumos support,
13+
and can be called on to assist contributors with illumos-specific issues. Please
14+
feel free to tag @tokio-rs/illumos to ask for help resolving build failures on
15+
illumos
16+
17+
[illumos]: https://www.illumos.org/
18+
[Buildomat]: https://github.com/oxidecomputer/buildomat
19+
[the Buildomat README]: https://github.com/oxidecomputer/buildomat
20+
[tokio-rs/illumos]: https://github.com/orgs/tokio-rs/teams/illumos

.github/buildomat/config.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Repository-level Buildomat configuration.
2+
# See: https://github.com/oxidecomputer/buildomat#per-repository-configuration
3+
4+
# Enable buildomat. This one should be self-explanatory.
5+
enable = true
6+
# Allow CI runs for PRs from users outside the `tokio-rs` organization. Our
7+
# buildomat jobs don't touch any secrets/keys, so this should be fine.
8+
org_only = false

0 commit comments

Comments
 (0)