Update input names

Author: ntowle

.github/workflows/luacheck.yml

@@ -20,7 +20,7 @@ jobs:
             luacheck
 
   script-only:
-    name: Test script only
+    name: Custom script only
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -31,12 +31,12 @@ jobs:
             -e GITHUB_WORKSPACE=/workspace \
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=false \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e INPUT_TEST_ARGS=. \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e INPUT_CUSTOM_ARGS=. \
             luacheck
 
   both-pass:
-    name: Luacheck and test script (both pass)
+    name: Luacheck and custom script (both pass)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -48,8 +48,8 @@ jobs:
             -e INPUT_FILES=test/sample.lua \
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=true \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e INPUT_TEST_ARGS=. \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e INPUT_CUSTOM_ARGS=. \
             luacheck
 
   both-disabled:
@@ -85,7 +85,7 @@ jobs:
           [ $? -ne 0 ]
 
   script-fails:
-    name: Test script fails (expect fail)
+    name: Custom script fails (expect fail)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -97,8 +97,8 @@ jobs:
             -e GITHUB_WORKSPACE=/workspace \
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=false \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e INPUT_TEST_ARGS=--fail \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e INPUT_CUSTOM_ARGS=--fail \
             luacheck
           [ $? -ne 0 ]
 
@@ -117,8 +117,8 @@ jobs:
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=true \
             -e INPUT_FAIL_FAST=true \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e INPUT_TEST_ARGS=. \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e INPUT_CUSTOM_ARGS=. \
             luacheck
           [ $? -ne 0 ]
 
@@ -137,8 +137,8 @@ jobs:
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=true \
             -e INPUT_FAIL_FAST=true \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e INPUT_TEST_ARGS=--fail \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e INPUT_CUSTOM_ARGS=--fail \
             luacheck
           [ $? -ne 0 ]
 
@@ -157,8 +157,8 @@ jobs:
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=true \
             -e INPUT_FAIL_FAST=false \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e INPUT_TEST_ARGS=. \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e INPUT_CUSTOM_ARGS=. \
             luacheck
           [ $? -ne 0 ]
 
@@ -177,8 +177,8 @@ jobs:
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=true \
             -e INPUT_FAIL_FAST=false \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e INPUT_TEST_ARGS=--fail \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e INPUT_CUSTOM_ARGS=--fail \
             luacheck
           [ $? -ne 0 ]
 
@@ -214,7 +214,7 @@ jobs:
             luacheck
 
   script-from-url:
-    name: Test script from URL
+    name: Custom script from URL
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -225,12 +225,12 @@ jobs:
             -e GITHUB_WORKSPACE=/workspace \
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=false \
-            -e INPUT_TEST_SCRIPT="https://raw.githubusercontent.com/${{ github.repository }}/${{ github.ref_name }}/test/validate.lua" \
-            -e INPUT_TEST_ARGS=. \
+            -e INPUT_CUSTOM_SCRIPT="https://raw.githubusercontent.com/${{ github.repository }}/${{ github.ref_name }}/test/validate.lua" \
+            -e INPUT_CUSTOM_ARGS=. \
             luacheck
 
   script-args:
-    name: Test script with multiple args
+    name: Custom script with multiple args
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -241,8 +241,8 @@ jobs:
             -e GITHUB_WORKSPACE=/workspace \
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=false \
-            -e INPUT_TEST_SCRIPT=test/validate.lua \
-            -e 'INPUT_TEST_ARGS=--echo foo bar' \
+            -e INPUT_CUSTOM_SCRIPT=test/validate.lua \
+            -e 'INPUT_CUSTOM_ARGS=--echo foo bar' \
             luacheck
 
   script-writes-repo:
@@ -257,7 +257,7 @@ jobs:
             -e GITHUB_WORKSPACE=/workspace \
             -e INPUT_PATH=. \
             -e INPUT_RUN_LUACHECK=false \
-            -e INPUT_TEST_SCRIPT=test/write.lua \
+            -e INPUT_CUSTOM_SCRIPT=test/write.lua \
             luacheck
       - name: Verify script wrote file
         run: test -f test/.written-by-script

README.md

@@ -1,6 +1,6 @@
 # luacheck
 
-A luacheck GitHub Action that runs in Docker. **No setup, instant run** — luacheck is pre-installed (Alpine + apk), so jobs start immediately. Self-contained, no external image dependencies.
+A luacheck GitHub Action that runs in Docker with a Lua entry point for custom scripts. luacheck and Lua 5.1 are pre-installed (Alpine + apk), so jobs start immediately.
 
 ## Usage
 
@@ -28,7 +28,7 @@ jobs:
           annotate: warning  # or "error" — emits GitHub annotations on PRs
 ```
 
-See this repo's [Luacheck workflow](.github/workflows/luacheck.yml) for usage examples (luacheck-only, test-script-only, and both).
+See this repo's [Luacheck workflow](.github/workflows/luacheck.yml) for usage examples (luacheck-only, custom-script-only, and both).
 
 ### Luacheck + script that modifies repo
 
@@ -37,8 +37,8 @@ See this repo's [Luacheck workflow](.github/workflows/luacheck.yml) for usage ex
         with:
           args: -q
           config: https://raw.githubusercontent.com/your-org/config/main/.luacheckrc
-          test_script: scripts/generate_options.lua
-          test_args: module1.toc module2.toc
+          custom_script: scripts/generate_options.lua
+          custom_args: module1.toc module2.toc
           fail_fast: false  # run both even if luacheck fails
 ```
 
@@ -51,10 +51,10 @@ See this repo's [Luacheck workflow](.github/workflows/luacheck.yml) for usage ex
 | `args` | `""` | Extra luacheck CLI arguments (see below) |
 | `config` | `""` | URL to custom `.luacheckrc` |
 | `annotate` | `none` | `none`, `warning`, or `error` — show issues as PR annotations (incompatible with `-qq`/`-qqq`) |
-| `test_script` | `""` | URL or path (relative to `path`, or absolute) to a Lua script to run after luacheck. Runs in the working directory and can modify repo files (e.g., code generation scripts). |
-| `test_args` | `"."` | Arguments passed to the test script |
+| `custom_script` | `""` | URL or path (relative to `path`, or absolute) to a Lua script to run after luacheck. Runs in the working directory and can modify repo files (e.g., code generation scripts). |
+| `custom_args` | `"."` | Arguments passed to the custom script |
 | `run_luacheck` | `true` | When false, skip luacheck (script-only mode) |
-| `fail_fast` | `false` | When true, exit on first failure. When false, run both luacheck and script, then exit with failure if any failed. |
+| `fail_fast` | `false` | When true, exit on first failure. When false, run both luacheck and the custom script, then exit with failure if any failed. |
 
 ### Common `args` options
 

action.yml

@@ -1,5 +1,5 @@
 name: luacheck
-description: Runs luacheck in a pre-built Docker container. Optionally runs a Lua test script (from URL or path) before or instead of luacheck.
+description: Runs luacheck in a pre-built Docker container. Optionally runs a custom Lua script (from URL or path) before or instead of luacheck.
 branding:
   icon: check-square
   color: yellow
@@ -31,14 +31,14 @@ inputs:
       Requires warnings not be suppressed (avoid -qq or -qqq with args).
     required: false
     default: none
-  test_script:
+  custom_script:
     description: >
       URL or path (relative to path, or absolute) to a Lua script to run after luacheck.
     required: false
     default: ''
-  test_args:
+  custom_args:
     description: >
-      Arguments passed to the test script.
+      Arguments passed to the custom script.
     required: false
     default: '.'
   run_luacheck:
@@ -67,8 +67,8 @@ runs:
           -e INPUT_ARGS="${{ inputs.args }}" \
           -e INPUT_CONFIG="${{ inputs.config }}" \
           -e INPUT_ANNOTATE="${{ inputs.annotate }}" \
-          -e INPUT_TEST_SCRIPT="${{ inputs.test_script }}" \
-          -e INPUT_TEST_ARGS="${{ inputs.test_args }}" \
+          -e INPUT_CUSTOM_SCRIPT="${{ inputs.custom_script }}" \
+          -e INPUT_CUSTOM_ARGS="${{ inputs.custom_args }}" \
           -e INPUT_RUN_LUACHECK="${{ inputs.run_luacheck }}" \
           -e INPUT_FAIL_FAST="${{ inputs.fail_fast }}" \
           -e GITHUB_WORKSPACE=/workspace \

entrypoint.sh

@@ -10,8 +10,8 @@ fi
 ARGS="${INPUT_ARGS:-}"
 CONFIG_URL="${INPUT_CONFIG:-}"
 ANNOTATE="${INPUT_ANNOTATE:-none}"
-TEST_SCRIPT="${INPUT_TEST_SCRIPT:-}"
-TEST_ARGS="${INPUT_TEST_ARGS:-.}"
+CUSTOM_SCRIPT="${INPUT_CUSTOM_SCRIPT:-}"
+CUSTOM_ARGS="${INPUT_CUSTOM_ARGS:-.}"
 RUN_LUACHECK="${INPUT_RUN_LUACHECK:-true}"
 FAIL_FAST="${INPUT_FAIL_FAST:-false}"
 
@@ -76,35 +76,35 @@ if [ "$RUN_LUACHECK" = "true" ]; then
     fi
 fi
 
-# Run test script when provided (URL or path)
+# Run custom script when provided (URL or path)
 script_exit=0
-if [ -n "$TEST_SCRIPT" ]; then
+if [ -n "$CUSTOM_SCRIPT" ]; then
     script_path=""
-    case "$TEST_SCRIPT" in
+    case "$CUSTOM_SCRIPT" in
         http://*|https://*)
             script_path="/tmp/script.lua"
-            if ! curl -fsSL "$TEST_SCRIPT" -o "$script_path"; then
-                echo "::error::Unable to download script from \"$TEST_SCRIPT\"" >&2
+            if ! curl -fsSL "$CUSTOM_SCRIPT" -o "$script_path"; then
+                echo "::error::Unable to download script from \"$CUSTOM_SCRIPT\"" >&2
                 exit 1
             fi
             ;;
         *)
-            if [ -f "$TEST_SCRIPT" ]; then
-                script_path="$TEST_SCRIPT"
-            elif [ -f "$WORK_DIR/$TEST_SCRIPT" ]; then
-                script_path="$WORK_DIR/$TEST_SCRIPT"
+            if [ -f "$CUSTOM_SCRIPT" ]; then
+                script_path="$CUSTOM_SCRIPT"
+            elif [ -f "$WORK_DIR/$CUSTOM_SCRIPT" ]; then
+                script_path="$WORK_DIR/$CUSTOM_SCRIPT"
             else
-                echo "::error::Test script not found: \"$TEST_SCRIPT\"" >&2
+                echo "::error::Custom script not found: \"$CUSTOM_SCRIPT\"" >&2
                 exit 1
             fi
             ;;
     esac
     set +e
-    lua5.1 "$script_path" $TEST_ARGS
+    lua5.1 "$script_path" $CUSTOM_ARGS
     script_exit=$?
     set -e
     if [ $script_exit -ne 0 ]; then
-        echo "::error::$TEST_SCRIPT failed with exit code $script_exit" >&2
+        echo "::error::$CUSTOM_SCRIPT failed with exit code $script_exit" >&2
         if [ "$FAIL_FAST" = "true" ]; then
             exit $script_exit
         fi

test/README.md

@@ -35,7 +35,7 @@ Fixtures used by the [Luacheck workflow](../.github/workflows/luacheck.yml). Eac
 - **config-url** — Config from raw GitHub URL
 - **args-quiet** — Luacheck `-q`
 - **script-from-url** — Script from raw GitHub URL
-- **script-args** — Multiple `test_args` (`--echo foo bar`)
+- **script-args** — Multiple `custom_args` (`--echo foo bar`)
 - **script-writes-repo** — Script writes file, verify with `test -f`
 - **path-subdir** — `path: test`
 - **files-specific** — `files: test/sample.lua`