This repository contains the automation the unables the unvanquished testing servers. It is supposed to replace nightly too, eventually. It may be extended to run other, public servers in the future.
There is an instance deployed on unvanquished.net.
The build automation in this repo monitors the following repos:
- https://github.com/Unvanquished/Unvanquished/
- https://github.com/UnvanquishedAssets/unvanquished\_src.dpkdir/
- https://github.com/DaemonEngine/Daemon/
It will monitor these 3 repositories and build a server for each branch that is
named either */deploy, */experimental, */testing or 0.53.0/sync. It
will assemble a server out of the desired branch of each repo. If a branch with
the same name is not available in the other repos, a fallback branch will be
used instead: experimental branches fallback to 0.XX.Y/sync (the exact name
is updated manually) while testing branches fallback to master.
This mean that if a branch is based on master you should name it using the
/testing suffix, and if a branch is based on the next release branch, you
must use the /experimental suffix.
The patterns matched in the "nobuild" file are excluded. This must be a regular expression suitable for grep.
Currently the /start-updater.sh scripts checks if there has been an update to the repos every (a bit more than) 3 minutes.
Each server runs as a dll build inside gdb inside bubblewrap inside tmux. GDB can be used to troubleshot crashed servers, and tmux to access the game's terminal easily.
For typical usage, you run start-updater.sh and leave it running. The updater
runs in tmux, and so does every server. The servers are started inside tmux
sessions.
Use tmux -L testing-server attach to join the tmux server after it was started,
and you can use ^b-s to switch between sessions.
This is the scripts that decides what to build and that will report the status.
See update.sh help for individual commands.
Note you can run the commands while the server is running. Every command except
update.sh deploy are perfectly safe to run in parallel or while the updater
is running. I think that the worst that can happen is that update.sh deploy
can give incorrect output if run twice at the same time.
You are not really supposed to call these files manually. If you want to
understand how they work, there should be a nice comment at the beginning of
each file. default.nix is the entry point.
- Install nix. Nix is available both on NixOS and on other Linux distros. It may work on MacOS but wasn't tested.
- Install bash, tmux, curl, jq and pgrep.
You don't need a GitHub API key, this updates slowly enough not to hit the github API limit for unauthenticated users. I guess you could update the curl commands if you need more frequent updates or if you want to extend this to include more repos.