nixpkgs/ci/README.md

# CI support files

This directory contains files to support CI, such as [GitHub Actions](https://github.com/NixOS/nixpkgs/tree/master/.github/workflows) and [Ofborg](https://github.com/nixos/ofborg).
This is in contrast with [`maintainers/scripts`](../maintainers/scripts) which is for human use instead.

## Pinned Nixpkgs

CI may need certain packages from Nixpkgs.
In order to ensure that the needed packages are generally available without building,
[`pinned.json`](./pinned.json) contains a pinned Nixpkgs version tested by Hydra.

Run [`update-pinned.sh`](./update-pinned.sh) to update it.

## `ci/nixpkgs-vet.sh BASE_BRANCH [REPOSITORY]`

Runs the [`nixpkgs-vet` tool](https://github.com/NixOS/nixpkgs-vet) on the HEAD commit, closely matching what CI does. This can't do exactly the same as CI, because CI needs to rely on GitHub's server-side Git history to compute the mergeability of PRs before the check can be started.
In turn, when contributors are running this tool locally, we don't want to have to push commits to test them, and we can also rely on the local Git history to do the mergeability check.

Arguments:

- `BASE_BRANCH`: The base branch to use, e.g. master or release-24.05
- `REPOSITORY`: The repository from which to fetch the base branch. Defaults to <https://github.com/NixOS/nixpkgs.git>.
ci: init directory This creates a new directory for all CI support files, will be populated in future commits. 2024-06-26 00:51:40 +02:00			`# CI support files`

			`This directory contains files to support CI, such as [GitHub Actions](https://github.com/NixOS/nixpkgs/tree/master/.github/workflows) and [Ofborg](https://github.com/nixos/ofborg).`
treewide: Fix or remove some markdown links Found using https://github.com/serokell/xrefcheck, which unfortunately can't trivially be enforced in CI because we also have the manual markdown files that need post-processing to be valid 2024-09-03 23:37:05 +02:00			This is in contrast with [`maintainers/scripts`](../maintainers/scripts) which is for human use instead.
ci: reusable Nix format Nixpkgs pin This is needed such that in the next commit, we can re-use the same version from a shell.nix, allowing people to have a guaranteed matching nixfmt version. 2024-06-26 00:52:13 +02:00
			`## Pinned Nixpkgs`

			`CI may need certain packages from Nixpkgs.`
			`In order to ensure that the needed packages are generally available without building,`
ci/pinned: manage nixpkgs and treefmt-nix with npins Instead of rolling our own update script which only works for a single pin, let's use npins. We can then use it for the treefmtNix pin as well, which was mostly unmaintained, so far. 2025-05-31 19:09:58 +02:00			[`pinned.json`](./pinned.json) contains a pinned Nixpkgs version tested by Hydra.
ci: reusable Nix format Nixpkgs pin This is needed such that in the next commit, we can re-use the same version from a shell.nix, allowing people to have a guaranteed matching nixfmt version. 2024-06-26 00:52:13 +02:00
ci/pinned: manage nixpkgs and treefmt-nix with npins Instead of rolling our own update script which only works for a single pin, let's use npins. We can then use it for the treefmtNix pin as well, which was mostly unmaintained, so far. 2025-05-31 19:09:58 +02:00			Run [`update-pinned.sh`](./update-pinned.sh) to update it.
nixpkgs-vet: update CI, docs, and release to 0.1.4 Everything gets moved into the `ci/` top-level directory. We keep behind `maintainers/scripts/check-by-name.sh` and `pkgs/test/check-by-name/pinned-version.txt` as they are going to cause CI errors and confusion until we get all the way through the various channels. They'll be removed in about a week or so. 2024-09-02 12:33:28 -07:00
			## `ci/nixpkgs-vet.sh BASE_BRANCH [REPOSITORY]`

			Runs the [`nixpkgs-vet` tool](https://github.com/NixOS/nixpkgs-vet) on the HEAD commit, closely matching what CI does. This can't do exactly the same as CI, because CI needs to rely on GitHub's server-side Git history to compute the mergeability of PRs before the check can be started.
			`In turn, when contributors are running this tool locally, we don't want to have to push commits to test them, and we can also rely on the local Git history to do the mergeability check.`

			`Arguments:`

			- `BASE_BRANCH`: The base branch to use, e.g. master or release-24.05
			- `REPOSITORY`: The repository from which to fetch the base branch. Defaults to <https://github.com/NixOS/nixpkgs.git>.