Continuous Integration (CI): Difference between revisions

From NixOS Wiki
imported>Profpatsch
Add basic CI page. Add nix-build-uncached section.
 
imported>Mic92
add buildkite + install-nix-action
Line 18: Line 18:


See [[Nix_on_Travis]] article
See [[Nix_on_Travis]] article
=== Github actions ===
See [https://github.com/cachix/install-nix-action install-nix-action] to install nix in Linux/macOS actions.
There is also [https://github.com/cachix/cachix-action one action] to setup [https://cachix.org/ cachix], a hosted binary cache.
=== Build kite ===
NixOS comes with a module to run [[https://buildkite.com build-kite]] agents:
<syntaxHighlight lang=nix>
{
  services.buildkite-agents.builder = {
    enable = true;
    # store a token provided in the  buildkite webinterface in the `Agents` tab under `Agents token`
    tokenPath = "/path/to/token";
    privateSshKeyPath = "/path/to/ssh/key;
  };
}
</syntaxHighlight>
[https://nixos.org/nixos/options.html#services.buildkite Further NixOS options]

Revision as of 21:54, 25 July 2020

Nix nicely integrates into your CI.

TODO: some general tips & tricks

nix-build, without downloading the result if already built

nix-build will always ensure the built store path is put in the local store, be it by building or by downloading from a substituter. On CI, we often only want to check whether we can build the derivation, without using or running the output.

This can be achieved by using `--dry-run` to check whether the result would be fetched, and only building it it has to be built.

nix-build-if-changed.py implements this in a relatively straightforward (but naïve) Python script.

nix-build-uncached implements it in a slightly more elaborate manner, and is available on nixpkgs (as the nix-build-uncached package).

Instructions for specific CI Providers

Travis CI

See Nix_on_Travis article

Github actions

See install-nix-action to install nix in Linux/macOS actions. There is also one action to setup cachix, a hosted binary cache.

Build kite

NixOS comes with a module to run [build-kite] agents:

{
  services.buildkite-agents.builder = {
    enable = true;
    # store a token provided in the  buildkite webinterface in the `Agents` tab under `Agents token`
    tokenPath = "/path/to/token";
    privateSshKeyPath = "/path/to/ssh/key;
  };
}

Further NixOS options