MirrorHub/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-15 06:14:57 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
nixpkgs/ci/nixpkgs-vet.sh

72 lines
2 KiB
Bash
Raw Normal View History

workflows/check-by-name: Pin nixpkgs-check-by-name tool Before this, the tool for CI would update when nixos-unstable updated, which is kind of terrible because you don't know when it happens, and it might break master. In fact, the tooling _right now_ has a serious bug and shouldn't be used! This PR addresses this by _pinning_ the tooling in Nixpkgs itself. Updating the tooling now requires two PRs: - The first PR to update the tooling source - (wait for Hydra to build and publish it in nixos-unstable) - The second PR to update the pinned tooling In turn you know exactly when the changes are going to take effect. This change however has additional benefits: - It makes CI more reproducible, because it doesn't depend on the state of nixos-unstable anymore - Updates to the tooling can be tested with the workflow itself, because PRs that update the pinned tool will be tested on the updated version - CI gets a sizable speed boost, because there's no need to download and evaluate a channel anymore - It makes it more realistic to move the source of the tool into a separate repository - It removes the brittle branch-specific logic that was previously needed to ensure that release branches use their own version of the tooling.
2024-01-16 18:30:21 +01:00
#!/usr/bin/env nix-shell
check-by-name: Don't use -I in shebang Original commit from https://github.com/NixOS/nixpkgs/pull/282226, message: Running CI locally is broken becauses the `-I` argument: - Clobbers $NIX_PATH - Is wrong for two reasons: - Has too many `..` elements, relative to the script's location - Isn't relative to the script's location (as with *.nix files), since shell scripts and POSIX in general interpret paths relative to the current working directory, not the canonical path of argv[0] - Is inconsistent, since this script has symlinks pointing at it from different depths in the repository There is no way to set this flag statically in a way that will work everywhere. The caller needs to use $NIX_PATH, or the script needs to take the `-I` value as an argument. This commit deletes the static `-I` flag.
2024-01-29 13:39:26 +01:00
#!nix-shell -i bash -p jq
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
set -o pipefail -o errexit -o nounset
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace() { echo >&2 "$@"; }
tmp=$(mktemp -d)
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
cleanup() {
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
# Don't exit early if anything fails to cleanup
set +o errexit
trace -n "Cleaning up.. "
[[ -e "$tmp/base" ]] && git worktree remove --force "$tmp/base"
[[ -e "$tmp/merged" ]] && git worktree remove --force "$tmp/merged"
rm -rf "$tmp"
trace "Done"
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
}
trap cleanup exit
repo=https://github.com/NixOS/nixpkgs.git
if (( $# != 0 )); then
baseBranch=$1
shift
else
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace "Usage: $0 BASE_BRANCH [REPOSITORY]"
trace "BASE_BRANCH: The base branch to use, e.g. master or release-23.11"
trace "REPOSITORY: The repository to fetch the base branch from, defaults to $repo"
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
exit 1
fi
if (( $# != 0 )); then
repo=$1
shift
fi
if [[ -n "$(git status --porcelain)" ]]; then
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -e "\e[33mWarning: Dirty tree, uncommitted changes won't be taken into account\e[0m"
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
fi
headSha=$(git rev-parse HEAD)
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -e "Using HEAD commit \e[34m$headSha\e[0m"
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -n "Creating Git worktree for the HEAD commit in $tmp/merged.. "
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
git worktree add --detach -q "$tmp/merged" HEAD
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace "Done"
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -n "Fetching base branch $baseBranch to compare against.. "
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
git fetch -q "$repo" refs/heads/"$baseBranch"
baseSha=$(git rev-parse FETCH_HEAD)
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -e "\e[34m$baseSha\e[0m"
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -n "Creating Git worktree for the base branch in $tmp/base.. "
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
git worktree add -q "$tmp/base" "$baseSha"
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace "Done"
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -n "Merging base branch into the HEAD commit in $tmp/merged.. "
tests.nixpkgs-check-by-name: Create script to run locally Due to the check soon depending on the base branch (see `--base`), the CI check can't reasonably share all code with a local check. We can still make a script to run it locally, just not sharing all code.
2023-12-16 03:13:12 +01:00
git -C "$tmp/merged" merge -q --no-edit "$baseSha"
pkgs/test/nixpkgs-check-by-name/scripts: Various improvements - trace function, avoids littering `echo >&2` all throughout - Avoid `eval`, remove unneeded shellcheck Co-Authored-By: Victor Engmark <victor@engmark.name>
2023-12-21 23:05:14 +01:00
trace -e "\e[34m$(git -C "$tmp/merged" rev-parse HEAD)\e[0m"
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 21:33:28 +02:00
trace -n "Reading pinned nixpkgs-vet version from pinned-version.txt.. "
toolVersion=$(<"$tmp/merged/ci/nixpkgs-vet/pinned-version.txt")
workflows/check-by-name.yml: Switch to new separate repo The nixpkgs-check-by-name tooling is [being moved](https://github.com/NixOS/nixpkgs/issues/286559#issuecomment-2000466124) to a [separate repo](https://github.com/NixOS/nixpkgs-check-by-name). This commit updates Nixpkgs CI to use it instead of the tree inside Nixpkgs No changes have been made to the tooling locally since it was moved: - [Exported history](https://github.com/NixOS/nixpkgs/commits/55bf02190ee57fcf83490fd7b6bf7834e28c9c86/pkgs/test/nixpkgs-check-by-name) - [Imported history](https://github.com/NixOS/nixpkgs-check-by-name/commits/d579e1821d56c79fd90dab34b991cc7bdab7a5c6/)
2024-03-22 02:20:08 +01:00
trace -e "\e[34m$toolVersion\e[0m"
check-by-name/run-local.sh: Make it usable for non-CI platforms Since https://github.com/NixOS/nixpkgs/pull/281374, the nixpkgs-check-by-name tooling is pinned to a specific /nix/store path to avoid having to evaluate Nixpkgs in CI. The same path is used for local runs, but that doesn't actually work when you're trying to run it on a platform different from CI. This commit makes it work by being clearer about platforms and making local runs check out the correct Nixpkgs to evaluate the tool from.
2024-01-16 23:04:26 +01:00
workflows/check-by-name.yml: Switch to new separate repo The nixpkgs-check-by-name tooling is [being moved](https://github.com/NixOS/nixpkgs/issues/286559#issuecomment-2000466124) to a [separate repo](https://github.com/NixOS/nixpkgs-check-by-name). This commit updates Nixpkgs CI to use it instead of the tree inside Nixpkgs No changes have been made to the tooling locally since it was moved: - [Exported history](https://github.com/NixOS/nixpkgs/commits/55bf02190ee57fcf83490fd7b6bf7834e28c9c86/pkgs/test/nixpkgs-check-by-name) - [Imported history](https://github.com/NixOS/nixpkgs-check-by-name/commits/d579e1821d56c79fd90dab34b991cc7bdab7a5c6/)
2024-03-22 02:20:08 +01:00
trace -n "Building tool.. "
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 21:33:28 +02:00
nix-build https://github.com/NixOS/nixpkgs-vet/tarball/"$toolVersion" -o "$tmp/tool" -A build
trace "Running nixpkgs-vet.."
"$tmp/tool/bin/nixpkgs-vet" --base "$tmp/base" "$tmp/merged"
Reference in a new issue Copy permalink