You can configure nix-ci on a per-commit basis by adding a
nix-ci.nix
file in your repository.
You can use this validator to validate your configuration without having to push a commit.
Run this command in your repository to validate your configuration:
nix eval --json --file ./nix-ci.nix | curl --netrc -H "Content-Type: application/json" -d @- https://nix-ci.com/documentation/configuration
Alternatively, you can run
nix eval --json --file ./nix-ci.nix
and paste the output below.
# SuiteConfiguration
enable: # optional
# default: true
# Enable CI
<boolean>
systems: # optional
# Only build for these systems. By default these are computed based on which workers are available for the repository.
# or null
- <string>
onlyBuild: # optional
# Only build these attributes.
# This does not affect test or deploy jobs.
# or null
- <string>
doNotBuild: # optional
# Exclude these attributes from building.
# This does not affect test or deploy jobs.
# or null
- <string>
git-ssh-key: # optional
# SSH Key to use for git-clone-ing
# By default no SSH key is used so Nix will fail to clone private dependencies.
# SshKeyConfiguration
secret: # required
# name of the secret on NixCI to use as the private key
<string>
public-key: # required
# public key of the ssh key
<string>
timeout: # optional
# Maximum timeout, in seconds. Note that the actual timeout may depend on the workers' configuration.
<number>
cache: # optional
# Ssh Cache configuration
# In order to push to the cache as well, the repository needs to have a SSH_CACHE_PRIVATE_KEY secret.
# SshCacheConfiguration
name: # optional
# ssh cache name, for logging
<string>
# any of
[ domain: # required
# cache domain, example: cache.nix-ci.com
<string>
, url: # required
# cache url, example: ssh://cache.nix-ci.com
<string>
]
user: # optional
# ssh user, defaults to the worker user
<string>
host-key: # optional
# ssh host key
<string>
public-key: # required
# ssh public key
<string>
cache-public-key: # optional
# cache verification public key
<string>
cachix: # optional
# Cachix configuration
# In order to push to the cache as well, the repository needs to have a CACHIX_AUTH_TOKEN or CACHIX_SIGNING_KEY secret.
# CachixConfiguration
name: # required
# cache name
<string>
public-key: # required
# cache public key (for pulling)
<string>
allow-import-from-derivation: # optional
# Show with --allow-import-from-derivation
# default: True
<boolean>
impure: # optional
# Build with --impure
# default: False
<boolean>
build-logs: # optional
# Build with --print-build-logs
# default: True
<boolean>
fail-fast: # optional
# Cancel the rest of a suite once one job fails
# default: True
<boolean>
auto-retry: # optional
# Automatically retry every individual failed run in a suite once
# default: True
<boolean>
dependency-discovery: # optional
# Dependency discovery configuration
# any of
[ # true: enable dependency discovery (synchronous defaults to False)
# false: disable dependency discovery
<boolean>
, # DependencyDiscovery
enable: # optional
# Enable automatic dependency discovery
# default: True
<boolean>
synchronous: # optional
# Wait for dependency detection to finish before starting builds
# default: False
<boolean>
]
dependencies: # optional
# Additional build dependencies on top of what is discovered automatically. A map from attribute to a list of attributes it depends on.
# or null
<key>:
- <string>
test: # optional
# default: {}
# Test Configurations
<key>:
# TestConfiguration
enable: # optional
# default: true
# enable this test
<boolean>
package: # required
# package of which the main program will be run
<string>
system: # optional
# system on which the test will be run
<string>
branches: # optional
# default: any
# branches from which may be tested
# any of
[ # Run from any branch
any
, # The same as "any"
all
, # Only run from the default branch
default
, # Do not run from any branch
none
, # Run from any of this list of branches
- <string>
, # true means any branch, false means none
<boolean>
]
in-repo: # optional
# Run the job in a checkout of the repository at the right revision
# default: False
# Setting this to false is more efficient if the job doesn't need to access to git history.
# You can use ${self} to refer to the flake source if you need access to the repository contents at the current commit only.
<boolean>
secrets: # optional
# default: []
# secrets provided to the test
- <string>
ssh-keys: # optional
# default: []
# ssh keys provided to the test
- # SshKeyConfiguration
secret: # required
# name of the secret on NixCI to use as the private key
<string>
public-key: # required
# public key of the ssh key
<string>
deploy: # optional
# default: {}
# Deploy Configurations
<key>:
# DeployConfiguration
enable: # optional
# default: true
# enable this deployment
<boolean>
package: # required
# package of which the main program will be run
<string>
system: # optional
# system on which the deployment will be run
<string>
branches: # optional
# default: default
# branches from which may be deployed
# any of
[ # Run from any branch
any
, # The same as "any"
all
, # Only run from the default branch
default
, # Do not run from any branch
none
, # Run from any of this list of branches
- <string>
, # true means any branch, false means none
<boolean>
]
in-repo: # optional
# Run the job in a checkout of the repository at the right revision
# default: False
# Setting this to false is more efficient if the job doesn't need to access to git history.
# You can use ${self} to refer to the flake source if you need access to the repository contents at the current commit only.
<boolean>
secrets: # optional
# default: []
# secrets provided to the deployment
- <string>
ssh-keys: # optional
# default: []
# ssh keys provided to the deployment
- # SshKeyConfiguration
secret: # required
# name of the secret on NixCI to use as the private key
<string>
public-key: # required
# public key of the ssh key
<string>