From 99f2e655d9db009ee0b4ede3edced5f6c882c7f4 Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Sun, 29 Jun 2025 19:14:47 +0200 Subject: [PATCH] ci/README.md: one sentence per line --- ci/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/ci/README.md b/ci/README.md index 7df3b1533e59..c55d0ca62d07 100644 --- a/ci/README.md +++ b/ci/README.md @@ -6,20 +6,21 @@ This is in contrast with [`maintainers/scripts`](../maintainers/scripts) which i ## 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. +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. +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 . +- `REPOSITORY`: The repository from which to fetch the base branch. + Defaults to . # Branch classification