Building buskill-app

This section documents how to build the BusKill App.

Note

Our build scripts are designed to be run on GitHub’s shared runners – disposable cloud instances. Therefore, our build scripts may make system-wide package changes and they may not cleanup at the end of their execution.

We recommend that you execute these on a fresh disposable VM and take a snapshot before proceeding.

Linux

Our build script is executed on GitHub’s shared runners, which use Ubuntu. For better reproducibility, the build script itself is executed inside a wrapper script that installs and executes the build script in a debian docker container. For more information, see:

  1. The list of Ubuntu versions in GitHub’s documentation
  2. Our build logs
sudo su -
sudo apt-get install git
git clone https://github.com/BusKill/buskill-app.git
cd buskill-app/
build/linux/debianWrapper.sh

Note

When first setting up your build environment, it may be helpful to reference our GitHub build workflow for Linux.

Windows

Our build script is executed on GitHub’s shared runners. For more information on the specific version of Windows you should use for best results, see:

  1. The list of Windows versions in GitHub’s documentation
  2. Our build logs
git clone https://github.com/BusKill/buskill-app.git
cd buskill-app/
build/windows/buildExe.ps1

Note

When first setting up your build environment, it may be helpful to reference our GitHub build workflow for Windows.

MacOS

Our build script is executed on GitHub’s shared runners. For more information on the specific version of MacOS you should use for best results, see:

  1. The list of MacOS versions in GitHub’s documentation
  2. Our build logs
sudo su -
git clone https://github.com/BusKill/buskill-app.git
cd buskill-app/
build/mac/buildDmg.sh

Note

When first setting up your build environment, it may be helpful to reference our GitHub build workflow for MacOS.