From 3869ba41274265150be6f9e233ae5f8f35f867ee Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Sat, 16 Dec 2023 03:01:03 +0100 Subject: workflows/check-by-name: Move tool fetching into script This part of the CI can also be reproduced locally --- .github/workflows/check-by-name.yml | 36 ++---------------------------------- 1 file changed, 2 insertions(+), 34 deletions(-) (limited to '.github/workflows') diff --git a/.github/workflows/check-by-name.yml b/.github/workflows/check-by-name.yml index 294775fa1c8e2..43237d36bee1b 100644 --- a/.github/workflows/check-by-name.yml +++ b/.github/workflows/check-by-name.yml @@ -79,40 +79,8 @@ jobs: echo "headSha=$(git rev-parse HEAD^2)" >> "$GITHUB_ENV" - uses: cachix/install-nix-action@7ac1ec25491415c381d9b62f0657c7a028df52a7 # v24 - - name: Determining channel to use for dependencies - run: | - echo "Determining the preferred channel to use for PR base branch $GITHUB_BASE_REF" - if [[ "$GITHUB_BASE_REF" =~ ^(release|staging|staging-next)-([0-9][0-9]\.[0-9][0-9])$ ]]; then - # Use the release channel for all PRs to release-XX.YY, staging-XX.YY and staging-next-XX.YY - channel=nixos-${BASH_REMATCH[2]} - echo "PR is for a release branch, preferred channel is $channel" - else - # Use the nixos-unstable channel for all other PRs - channel=nixos-unstable - echo "PR is for a non-release branch, preferred channel is $channel" - fi - # Check that the channel exists. It doesn't exist for fresh release branches - if ! curl -fSs "https://channels.nixos.org/$channel"; then - # Fall back to nixos-unstable, makes sense for fresh release branches - echo "Preferred channel $channel could not be fetched, falling back to nixos-unstable" - channel=nixos-unstable - fi - echo "channel=$channel" >> "$GITHUB_ENV" - - name: Fetching latest version of channel - run: | - echo "Fetching latest version of channel $channel" - # This is probably the easiest way to get Nix to output the path to a downloaded channel! - nixpkgs=$(nix-instantiate --find-file nixpkgs -I nixpkgs=channel:"$channel") - # This file only exists in channels - rev=$(<"$nixpkgs"/.git-revision) - echo "Channel $channel is at revision $rev" - echo "nixpkgs=$nixpkgs" >> "$GITHUB_ENV" - echo "rev=$rev" >> "$GITHUB_ENV" - - name: Fetching pre-built nixpkgs-check-by-name from the channel - run: | - echo "Fetching pre-built nixpkgs-check-by-name from channel $channel at revision $rev" - # Passing --max-jobs 0 makes sure that we won't build anything - nix-build "$nixpkgs" -A tests.nixpkgs-check-by-name --max-jobs 0 + - name: Fetching the tool + run: pkgs/test/nixpkgs-check-by-name/scripts/fetch-tool.sh "$GITHUB_BASE_REF" result - name: Running nixpkgs-check-by-name run: | echo "Checking whether the check succeeds on the base branch $GITHUB_BASE_REF" -- cgit 1.4.1 From c6267887db1379c3854c4f604b121b6ff7560a7a Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Sat, 16 Dec 2023 03:02:33 +0100 Subject: workflows/check-by-name: Why the mergeability check needs to be inline --- .github/workflows/check-by-name.yml | 3 +++ 1 file changed, 3 insertions(+) (limited to '.github/workflows') diff --git a/.github/workflows/check-by-name.yml b/.github/workflows/check-by-name.yml index 43237d36bee1b..0fce2c37746ce 100644 --- a/.github/workflows/check-by-name.yml +++ b/.github/workflows/check-by-name.yml @@ -20,6 +20,9 @@ jobs: # The default of 6 hours is definitely too long timeout-minutes: 10 steps: + # This step has to be in this file, + # because it's needed to determine which revision of the repository to fetch, + # and we can only use other files from the repository once it's fetched. - name: Resolving the merge commit env: GH_TOKEN: ${{ github.token }} -- cgit 1.4.1 From 1ad45e503f3acdcb3df214b58d289511ddf2eff8 Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Sat, 16 Dec 2023 03:13:35 +0100 Subject: workflows/check-by-name: Slim down and prepare for --base Now that we have a script to run the check locally, there's no real need to output the information to reproduce anymore, which allows cleaning up the CI workflow. Furthermore, this prepares the CI workflow to be passed `--base`, as introduced recently. --- .github/workflows/check-by-name.yml | 92 +++++-------------------------------- 1 file changed, 11 insertions(+), 81 deletions(-) (limited to '.github/workflows') diff --git a/.github/workflows/check-by-name.yml b/.github/workflows/check-by-name.yml index 0fce2c37746ce..c006ffc78f56b 100644 --- a/.github/workflows/check-by-name.yml +++ b/.github/workflows/check-by-name.yml @@ -1,5 +1,7 @@ # Checks pkgs/by-name (see pkgs/by-name/README.md) # using the nixpkgs-check-by-name tool (see pkgs/test/nixpkgs-check-by-name) +# +# When you make changes to this workflow, also update pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh adequately name: Check pkgs/by-name # The pre-built tool is fetched from a channel, @@ -75,92 +77,20 @@ jobs: ref: ${{ env.mergedSha }} # Fetches the merge commit and its parents fetch-depth: 2 - - name: Determining PR git hashes + - name: Checking out base branch run: | - # For pull_request_target this is the same as $GITHUB_SHA - echo "baseSha=$(git rev-parse HEAD^1)" >> "$GITHUB_ENV" - - echo "headSha=$(git rev-parse HEAD^2)" >> "$GITHUB_ENV" + base=$(mktemp -d) + git worktree add "$base" "$(git rev-parse HEAD^1)" + echo "base=$base" >> "$GITHUB_ENV" - uses: cachix/install-nix-action@7ac1ec25491415c381d9b62f0657c7a028df52a7 # v24 - name: Fetching the tool run: pkgs/test/nixpkgs-check-by-name/scripts/fetch-tool.sh "$GITHUB_BASE_REF" result - name: Running nixpkgs-check-by-name run: | - echo "Checking whether the check succeeds on the base branch $GITHUB_BASE_REF" - git checkout -q "$baseSha" - if baseOutput=$(result/bin/nixpkgs-check-by-name . 2>&1); then - baseSuccess=1 + if result/bin/nixpkgs-check-by-name .; then + exit 0 else - baseSuccess= + exitCode=$? + echo "To run locally: ./pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh $GITHUB_BASE_REF https://github.com/$GITHUB_REPOSITORY.git" + exit "$exitCode" fi - printf "%s\n" "$baseOutput" - - echo "Checking whether the check would succeed after merging this pull request" - git checkout -q "$mergedSha" - if mergedOutput=$(result/bin/nixpkgs-check-by-name . 2>&1); then - mergedSuccess=1 - exitCode=0 - else - mergedSuccess= - exitCode=1 - fi - printf "%s\n" "$mergedOutput" - - resultToEmoji() { - if [[ -n "$1" ]]; then - echo ":heavy_check_mark:" - else - echo ":x:" - fi - } - - # Print a markdown summary in GitHub actions - { - echo "| Nixpkgs version | Check result |" - echo "| --- | --- |" - echo "| Latest base commit | $(resultToEmoji "$baseSuccess") |" - echo "| After merging this PR | $(resultToEmoji "$mergedSuccess") |" - echo "" - - if [[ -n "$baseSuccess" ]]; then - if [[ -n "$mergedSuccess" ]]; then - echo "The check succeeds on both the base branch and after merging this PR" - else - echo "The check succeeds on the base branch, but would fail after merging this PR:" - echo "\`\`\`" - echo "$mergedOutput" - echo "\`\`\`" - echo "" - fi - else - if [[ -n "$mergedSuccess" ]]; then - echo "The check fails on the base branch, but this PR fixes it, nicely done!" - else - echo "The check fails on both the base branch and after merging this PR, unknown if only this PRs changes would satisfy the check, the base branch needs to be fixed first." - echo "" - echo "Failure on the base branch:" - echo "\`\`\`" - echo "$baseOutput" - echo "\`\`\`" - echo "" - echo "Failure after merging this PR:" - echo "\`\`\`" - echo "$mergedOutput" - echo "\`\`\`" - echo "" - fi - fi - - echo "### Details" - echo "- nixpkgs-check-by-name tool:" - echo " - Channel: $channel" - echo " - Nixpkgs commit: [$rev](https://github.com/${GITHUB_REPOSITORY}/commit/$rev)" - echo " - Store path: \`$(realpath result)\`" - echo "- Tested Nixpkgs:" - echo " - Base branch: $GITHUB_BASE_REF" - echo " - Latest base branch commit: [$baseSha](https://github.com/${GITHUB_REPOSITORY}/commit/$baseSha)" - echo " - Latest PR commit: [$headSha](https://github.com/${GITHUB_REPOSITORY}/commit/$headSha)" - echo " - Merge commit: [$mergedSha](https://github.com/${GITHUB_REPOSITORY}/commit/$mergedSha)" - } >> "$GITHUB_STEP_SUMMARY" - - exit "$exitCode" -- cgit 1.4.1 From 1968beeabd763cec23ab7164342a4193214791c7 Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Tue, 19 Dec 2023 23:12:41 +0100 Subject: check-by-name: Pass --base in CI and local running script This enables the ratchet checks for pkgs/by-name, allowing gradual migrations! --- .github/workflows/check-by-name.yml | 2 +- pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to '.github/workflows') diff --git a/.github/workflows/check-by-name.yml b/.github/workflows/check-by-name.yml index c006ffc78f56b..a761f6cae09bb 100644 --- a/.github/workflows/check-by-name.yml +++ b/.github/workflows/check-by-name.yml @@ -87,7 +87,7 @@ jobs: run: pkgs/test/nixpkgs-check-by-name/scripts/fetch-tool.sh "$GITHUB_BASE_REF" result - name: Running nixpkgs-check-by-name run: | - if result/bin/nixpkgs-check-by-name .; then + if result/bin/nixpkgs-check-by-name --base "$base" .; then exit 0 else exitCode=$? diff --git a/pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh b/pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh index a1debe73f8ad8..060f83469f4df 100755 --- a/pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh +++ b/pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh @@ -63,4 +63,4 @@ echo >&2 -e "\e[34m$(git -C "$tmp/merged" rev-parse HEAD)\e[0m" cleanup_commands+=('rm "$tmp/tool"') echo >&2 "Running nixpkgs-check-by-name.." -"$tmp/tool/bin/nixpkgs-check-by-name" "$tmp/merged" +"$tmp/tool/bin/nixpkgs-check-by-name" --base "$tmp/base" "$tmp/merged" -- cgit 1.4.1 From f882df781ca7eab4ee66fa31dda445937ccaedd3 Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Thu, 21 Dec 2023 23:09:50 +0100 Subject: maintainers/scripts/check-by-name.sh: Introduce symlink alias --- .github/workflows/check-by-name.yml | 2 +- maintainers/scripts/README.md | 4 ++++ maintainers/scripts/check-by-name.sh | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) create mode 120000 maintainers/scripts/check-by-name.sh (limited to '.github/workflows') diff --git a/.github/workflows/check-by-name.yml b/.github/workflows/check-by-name.yml index a761f6cae09bb..06fefcb6759ba 100644 --- a/.github/workflows/check-by-name.yml +++ b/.github/workflows/check-by-name.yml @@ -91,6 +91,6 @@ jobs: exit 0 else exitCode=$? - echo "To run locally: ./pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh $GITHUB_BASE_REF https://github.com/$GITHUB_REPOSITORY.git" + echo "To run locally: ./maintainers/scripts/check-by-name.sh $GITHUB_BASE_REF https://github.com/$GITHUB_REPOSITORY.git" exit "$exitCode" fi diff --git a/maintainers/scripts/README.md b/maintainers/scripts/README.md index 2b99a4e751141..f8fc7aff955d3 100644 --- a/maintainers/scripts/README.md +++ b/maintainers/scripts/README.md @@ -9,6 +9,10 @@ What follows is a (very incomplete) overview of available scripts. ## Metadata +### `check-by-name.sh` + +An alias for `pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh`, see [documentation](../../pkgs/test/nixpkgs-check-by-name/scripts/README.md). + ### `get-maintainer.sh` `get-maintainer.sh [selector] value` returns a JSON object describing diff --git a/maintainers/scripts/check-by-name.sh b/maintainers/scripts/check-by-name.sh new file mode 120000 index 0000000000000..545dbedf0a317 --- /dev/null +++ b/maintainers/scripts/check-by-name.sh @@ -0,0 +1 @@ +../../pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh \ No newline at end of file -- cgit 1.4.1