maintainers/scripts/check-by-name.sh: Introduce symlink alias

tweag · Dec 21, 2023 · f882df7 · f882df7
1 parent 1968bee
commit f882df7
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git 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
@@ -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
@@ -0,0 +1 @@
+../../pkgs/test/nixpkgs-check-by-name/scripts/run-local.sh