mirror of https://gitlab.com/TECHNOFAB/nix-gitlab-ci.git synced 2025-12-11 17:50:08 +01:00

Allows (advanced) configuration of GitLab CI using Nix. https://nix-gitlab-ci.projects.tf

Find a file

technofab 586fb88b9d feat(v2): initial v2 implementation add multi-arch (arm & x64) image add multiple pipelines (ci now creates the "default" pipeline as a shorthand) simplify devenv flake input merge all cache options together, now $NIX_CI_CACHE_STRATEGY decides how the cache works setup_nix_ci and finalize_nix_ci are now flake packages and work standalone the specific image is not needed anymore, any image with the right dependencies works runner cache is not the default anymore (because it sucked most of the time) the pipeline is selected by $NIX_CI_PIPELINE_NAME or if empty by $CI_PIPELINE_SOURCE, so for the old behaviour $NIX_CI_PIPELINE_NAME=default is needed, future work will be needed to handle this more nicely		2025-02-21 12:24:54 +01:00
lib	feat(v2): initial v2 implementation	2025-02-21 12:24:54 +01:00
templates	feat(v2): initial v2 implementation	2025-02-21 12:24:54 +01:00
.envrc	chore: initial commit	2024-01-14 16:45:07 +01:00
.gitignore	chore: initial commit	2024-01-14 16:45:07 +01:00
.gitlab-ci.yml	feat(v2): initial v2 implementation	2025-02-21 12:24:54 +01:00
flake.lock	feat(v2): initial v2 implementation	2025-02-21 12:24:54 +01:00
flake.nix	feat(v2): initial v2 implementation	2025-02-21 12:24:54 +01:00
gitlab-ci.yml	chore: add treefmt and format files	2024-09-13 17:22:38 +02:00
LICENSE.md	chore(LICENSE): use markdown for better readability	2024-10-30 16:11:19 +00:00
README.md	feat(v2): initial v2 implementation	2025-02-21 12:24:54 +01:00

README.md

Nix Gitlab CI

Flake module which allows generating a .gitlab-ci.yml from Nix.

This allows easily using any Nix package in CI.

Also makes it possible to split CI parts in a separate module which can be imported in multiple projects.

Usage

# flake.nix
{
  ...
  inputs.nix-gitlab-ci.url = "gitlab:TECHNOFAB/nix-gitlab-ci?dir=lib";
  
  outputs = {...}: flake-parts.lib.mkFlake {...} {
    imports = [
      inputs.nix-gitlab-ci.flakeModule
    ];
    ...
    
    perSystem = {pkgs, ...}: {
      # ci is a shortcut and creates a "default" pipeline
      ci = {
        stages = ["test"];
        jobs = {
          "test" = {
            stage = "test";
            nix.deps = [pkgs.unixtools.ping];
            script = [
              "ping -c 5 8.8.8.8"
            ];
          };
        };
      };
      # runs on a merge request for example
      pipelines."merge_request_event" = {
        stages = ["some_stage"];
        jobs = { ... };
      };
      ...
    }
  }
}

# .gitlab-ci.yml
include:
  - component: gitlab.com/TECHNOFAB/nix-gitlab-ci/nix-gitlab-ci@<version>  # recommendation: use the latest version (try not to use latest)

Utilities

Disable Caching temporarily

To disable any of the provided caches for a pipeline one can set NIX_CI_DISABLE_CACHE to anything non-empty (eg. "yes") when triggering the pipeline.

The build:nix-ci job has a different special environment variable NIX_CI_FORCE_BUILD (useful if the generated pipeline in the cache is outdated, this will build it again).

Run Jobs locally

You can run any job's script (+ before and after) locally with Nix for easier testing:

#                                /  pipeline name, like "default"
nix run .#gitlab-ci:pipeline:<pipeline name>:job:<name>

There is also .#gitlab-ci:pipeline:<pipeline name>:job-deps:<name> which generates and exports the required environment variables for each job:

PATH (with all deps)
any custom env variables which contain store paths to not break stuff when switching archs

Thanks to

Some parts of this implementation are adapted/inspired from https://gitlab.com/Cynerd/gitlab-ci-nix