mirror of
https://gitlab.com/TECHNOFAB/nix-gitlab-ci.git
synced 2025-12-12 10:10:06 +01:00
technofab
cf80010d07
Squashed commit of the following: commit 86eadd3ec42b7bce0dc5716d65798af95d0d8cbc Author: technofab <admin@technofab.de> Date: Fri May 2 17:10:33 2025 +0200 docs(README): fix built with nix badge commit f50057da69e89974f17bc37b5e140b2ef9f817f6 Author: technofab <admin@technofab.de> Date: Fri May 2 16:09:00 2025 +0200 ci: change back rule so docs only get deployed on main commit ce02b043f4bd83c36285e5620e71701fc3bcc998 Author: technofab <admin@technofab.de> Date: Fri May 2 16:08:10 2025 +0200 docs: write docs and improve formatter etc. commit e996b23cf877d8021759b782aa5996f5e2bf12ac Author: technofab <admin@technofab.de> Date: Fri May 2 16:07:56 2025 +0200 docs: update README commit 650f97b5608c32cf6cf66cc3fdd0965dc42e4860 Author: technofab <admin@technofab.de> Date: Wed Apr 23 21:05:14 2025 +0200 docs: add favicon commit 67e1bfecbcaf0b8f7dad2eecfaccf774cc560874 Author: technofab <admin@technofab.de> Date: Wed Apr 23 20:53:44 2025 +0200 docs: initial setup
107 lines
5.4 KiB
Markdown
107 lines
5.4 KiB
Markdown
# Environment Variables
|
|
|
|
Nix GitLab CI is mostly controlled using environment variables.
|
|
This page outlines all the variables and their use case.
|
|
|
|
## `NIX_CI_IMAGE`
|
|
|
|
| | |
|
|
| ----------- | -------------------------------------------------------------------------- |
|
|
| Default | `registry.gitlab.com/technofab/nix-gitlab-ci/nix-ci@$[[ inputs.version ]]` |
|
|
| Description | Image to use for the jobs |
|
|
|
|
## `NIX_CI_PIPELINE_NAME`
|
|
|
|
| | |
|
|
| ----------- | ------------------------------------------------- |
|
|
| Default | N/A |
|
|
| Description | Explicitly request a pipeline to be built and ran |
|
|
| See also | [Multi Pipeline](./multi_pipeline.md) |
|
|
|
|
## `NIX_CI_DEFAULT_SOURCES`
|
|
|
|
| | |
|
|
| ----------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
| Default | `.*` |
|
|
| Description | Regex to match `$CI_PIPELINE_SOURCE` against. If it matches, the `default` pipeline will be ran, otherwise `$CI_PIPELINE_SOURCE` |
|
|
| See also | [Multi Pipeline](./multi_pipeline.md) |
|
|
|
|
## `NIX_CI_FORCE_BUILD`
|
|
|
|
| | |
|
|
| ----------- | -------------------------------------------------------------------------------------- |
|
|
| Default | N/A |
|
|
| Description | Set to any non-empty value to force the `nix-ci:build` job to freshly build the config |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `NIX_CI_DISABLE_CACHE`
|
|
|
|
| | |
|
|
| ----------- | ------------------------------------------------------ |
|
|
| Default | N/A |
|
|
| Description | Set to any non-empty value to disable caching for jobs |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `NIX_CI_CACHE_STRATEGY`
|
|
|
|
| | |
|
|
| ----------- | --------------------------------------------------------------------------------- |
|
|
| Default | `$[[ inputs.cache_strategy ]]` -> defaults to `auto` |
|
|
| Description | Caching strategy to use. `auto` will select the strategy based on runner settings |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `NIX_CI_RUNNER_CACHE_STRATEGY`
|
|
|
|
| | |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| Default | N/A |
|
|
| Description | Every runner can set it's own preferred cache strategy with this |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `NIX_CI_DEFAULT_CACHE_STRATEGY`
|
|
|
|
| | |
|
|
| ----------- | ------------------------------------------------------------------------------------------------- |
|
|
| Default | `none` |
|
|
| Description | If no runner cache strategy is set and the main strategy is set to auto, this will be the default |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `RUNNER_CACHE`
|
|
|
|
| | |
|
|
| ----------- | -------------------------------------- |
|
|
| Default | `.nix-cache` |
|
|
| Description | Path to directory for the runner cache |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `CACHIX_CACHE`
|
|
|
|
| | |
|
|
| ----------- | ------------------------------- |
|
|
| Default | N/A |
|
|
| Description | Name of the cachix cache to use |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `ATTIC_CACHE`
|
|
|
|
| | |
|
|
| ----------- | ------------------------------ |
|
|
| Default | N/A |
|
|
| Description | Name of the attic cache to use |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `ATTIC_SERVER`
|
|
|
|
| | |
|
|
| ----------- | ----------------------- |
|
|
| Default | N/A |
|
|
| Description | URL of the attic server |
|
|
| See also | [Caching](./caching.md) |
|
|
|
|
## `ATTIC_TOKEN`
|
|
|
|
| | |
|
|
| ----------- | ------------------------------- |
|
|
| Default | N/A |
|
|
| Description | API token from the attic server |
|
|
| See also | [Caching](./caching.md) |
|