Shell access for builds.sr.ht CI

Published 2019-08-19 on Drew DeVault's blog

Have you ever found yourself staring at a failed CI build, wondering desperately what happened? Or, have you ever needed a fresh machine on-demand to test out an idea in? Have you been working on Linux, but need to test something on OpenBSD? Starting this week, builds.sr.ht can help with all of these problems, because you can now SSH into the build environment.

If you didn’t know, Sourcehut is the 100% open/libre software forge for hackers, complete with git and Mercurial hosting, CI, mailing lists, and more - with no JavaScript. Try it out!

The next time your build fails on builds.sr.ht, you’ll probably notice the following message:

Screenshot of builds.sr.ht showing a prompt to SSH into the failed build
VM and examine it

After the build fails, we process everything normally - sending emails, webhooks, and so on - but keep the VM booted for an additional 10 minutes. If you do log in during this window, we keep the VM alive until you log out or until your normal build time limit has elapsed. Once you’ve logged in, you get a shell and can do anything you like, such as examining the build artifacts or tweaking the source and trying again.

$ ssh -t builds@azusa.runners.sr.ht connect 81809
Connected to build job #81809 (failed):
https://builds.sr.ht/jobs/~sircmpwn/81809
Your VM will be terminated 4 hours from now, or when you log out.

bash-5.0 $

You can also connect to any build over SSH by adding shell: true to your build manifest. When you do, the VM will be kept alive after all of the tasks have finished (even if it doesn’t fail) so you can SSH in. You can also SSH in before the tasks have finished, and tail the output of the build in your terminal. An example use case might be getting a fresh Alpine environment to test build your package on:

This was accomplished with a simple build manifest:

image: alpine/edge
shell: true
sources:
- https://git.alpinelinux.org/aports
tasks:
- "prep-abuild": |
    abuild-keygen -an

Since build manifests run normally in advance of your shell login, you can do things like install your preferred editor and dotfiles, pull down your SSH keys through build secrets, or anything else you desire to set up a comfortable working environment.

Furthermore, by leveraging the builds.sr.ht API, you can write scripts which take advantage of the shell features. Need a NetBSD shell? With a little scripting you can get something like this working:

With experimental multiarch support being rolled out, soon you’ll be just a few keystrokes away from an ARM or PowerPC shell, too.

I want to expand more on SSH access in the future. Stay tuned and let me know if you have any cool ideas!

Have a comment on one of my posts? Start a discussion in my public inbox by sending an email to ~sircmpwn/public-inbox@lists.sr.ht [mailing list etiquette]


Articles from blogs I follow around the net

Working with Errors in Go 1.13

Go’s treatment of errors as values has served us well over the last decade. Although the standard library’s support for errors has been minimal—just the errors.New and fmt.Errorf functions, which produce errors that contain only a message—the built-in error …

via The Go Programming Language Blog October 17, 2019

Working full-time on open-source software

I’ll soon be working full-time on open-source software! I’m pleased to announce that I’m joining Sourcehut. Huge thanks to Drew DeVault for making this possible. I also want to thank everyone supporting Sourcehut and allowing it to grow. Being able to do …

via emersion October 15, 2019

Updates in September 2019

This post gives an overview of the recent updates to the Writing an OS in Rust blog and the used libraries and tools. I finished my master thesis and got my degree this month, so I only had limited time for my open source work. I still managed to perform a…

via Writing an OS in Rust October 6, 2019

Generated by openring