It is possible to run local integrations in order to identify any errors before pushing or sending a merge request to the repositories. Currently we have two build systems integrated on the repository both of them are based on Nix, so the first steps will be install NixOS in your system
- Install Nix as explained here https://nixos.org/nix/download.html (opens in a new tab). On most systems, it is enough to do:
sh <(curl -L https://nixos.org/nix/install) --no-daemon
Install git, and bash, although on most systems this comes pre-installed. Once NixOS installation has finished you need to install Makes framework
nix profile install github:fluidattacks/makes/<version>
You can check our current version here (opens in a new tab) Check Makes documentation (opens in a new tab) for more info. Once NixOS and Makes are installed in our system, we can proceed to make local builds
- Meet the builder: In root folder of the challenges repo run
$ m .
This will display a help message by default and the list of checks available.
Please make sure to commit your changes before running any local build, as staging changes will not be taken into account.
- If the integration was successful, commit your changes and create a merge request.
In Operating Systems different from Linux (Windows, Mac, etc): Continuous integration will hardly be available for OS different from Linux. Additionally in your everyday life at some of our sponsor companies you'd need to be familiar with Linux and its weapons. Hence we strongly recommend you to install it on your computer, or at least, to work with a Linux virtual machine.
We recommend installing virtualization software (VMware, Virtualbox) and creating a virtual machine based on a Linux distribution (e.g. Ubuntu, or another one of your liking). Then, follow the same procedure described above for Linux.