mirror of
https://gitlab.com/TECHNOFAB/nix-gitlab-ci.git
synced 2025-12-12 18:20:07 +01:00
technofab
586fb88b9d
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
80 lines
2.1 KiB
Markdown
80 lines
2.1 KiB
Markdown
# 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
|
|
|
|
```nix
|
|
# 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 = { ... };
|
|
};
|
|
...
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
```yaml
|
|
# .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:
|
|
|
|
```sh
|
|
# / 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
|