Replace requirements-command with command across workflows, docs, and scripts (#9)

Author: hbelmiro

.github/workflows/test.yml

@@ -73,7 +73,7 @@ jobs:
           export PATH="$HOME/.local/bin:$PATH"
           uv sync
       
-      - name: Test with default uv sync command (no requirements-command specified)
+      - name: Test with default uv sync command (no command specified)
         uses: ./
         with:
           pyproject-path: test-project/pyproject.toml
@@ -115,7 +115,7 @@ jobs:
         with:
           pyproject-path: test-project/pyproject.toml
           requirements-path: test-project/requirements.txt
-          requirements-command: uv pip compile pyproject.toml -o requirements.txt
+          command: uv pip compile pyproject.toml -o requirements.txt
 
   test-custom-requirements:
     runs-on: ubuntu-latest
@@ -153,7 +153,7 @@ jobs:
         with:
           pyproject-path: test-project/pyproject.toml
           requirements-path: test-project/requirements-linux.txt
-          requirements-command: uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt
+          command: uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt
 
   test-requirements-failure:
     runs-on: ubuntu-latest
@@ -170,7 +170,7 @@ jobs:
         with:
           pyproject-path: ./test-fixtures/requirements-out-of-sync/pyproject.toml
           requirements-path: ./test-fixtures/requirements-out-of-sync/requirements.txt
-          requirements-command: uv pip compile ./test-fixtures/requirements-out-of-sync/pyproject.toml -o ./test-fixtures/requirements-out-of-sync/requirements.txt
+          command: uv pip compile ./test-fixtures/requirements-out-of-sync/pyproject.toml -o ./test-fixtures/requirements-out-of-sync/requirements.txt
       - name: Assert action failed
         run: |
           if [[ "${{ steps.action_step.outcome }}" == "success" ]]; then
@@ -221,13 +221,13 @@ jobs:
         uses: ./
         with:
           pyproject-path: test-project/pyproject.toml
-          requirements-command: uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt
+          command: uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt
           requirements-path: test-project/requirements-linux.txt
       - name: Check Windows Requirements
         uses: ./
         with:
           pyproject-path: test-project/pyproject.toml
-          requirements-command: uv pip compile --python-platform=windows pyproject.toml -o requirements-win.txt
+          command: uv pip compile --python-platform=windows pyproject.toml -o requirements-win.txt
           requirements-path: test-project/requirements-win.txt 
 
   test-failure:
@@ -245,7 +245,7 @@ jobs:
         with:
           pyproject-path: ./test-fixtures/uv-lock-out-of-sync/pyproject.toml
           requirements-path: ./test-fixtures/uv-lock-out-of-sync/requirements.txt
-          requirements-command: uv pip compile ./test-fixtures/uv-lock-out-of-sync/pyproject.toml -o ./test-fixtures/uv-lock-out-of-sync/requirements.txt
+          command: uv pip compile ./test-fixtures/uv-lock-out-of-sync/pyproject.toml -o ./test-fixtures/uv-lock-out-of-sync/requirements.txt
       - name: Assert action failed
         run: |
           if [[ "${{ steps.action_step.outcome }}" == "success" ]]; then
@@ -273,4 +273,4 @@ jobs:
         uses: ./
         with:
           pyproject-path: ./test-fixtures/python-version-tilde/pyproject.toml
-          requirements-command: uv sync --directory ./test-fixtures/python-version-tilde
+          command: uv sync --directory ./test-fixtures/python-version-tilde

README.md

@@ -41,22 +41,22 @@ jobs:
     requirements-path: 'path/to/requirements.txt'
 ```
 
-### With Custom Requirements Command
+### With Custom Command
 
 ```yaml
 - uses: hbelmiro/uv-lock-check@v1
   with:
-    requirements-command: 'uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt'
+    command: 'uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt'
     requirements-path: 'requirements-linux.txt'
 ```
 
 ## Inputs
 
-| Input | Description | Required | Default |
-|-------|-------------|----------|---------|
-| `pyproject-path` | Path to the pyproject.toml file | No | `pyproject.toml` |
-| `requirements-path` | Path to the requirements.txt file. If empty, will look for requirements.txt in the same directory as pyproject.toml | No | `''` |
-| `requirements-command` | Complete uv command to generate requirements.txt | No | `uv sync` |
+| Input               | Description                                                                                                         | Required | Default          |
+|---------------------|---------------------------------------------------------------------------------------------------------------------|----------|------------------|
+| `pyproject-path`    | Path to the pyproject.toml file                                                                                     | No       | `pyproject.toml` |
+| `requirements-path` | Path to the requirements.txt file. If empty, will look for requirements.txt in the same directory as pyproject.toml | No       | `''`             |
+| `command`           | uv command to run for validation                                                                                    | No       | `uv sync`        |
 
 ## How It Works
 
@@ -74,7 +74,7 @@ jobs:
 ```yaml
 - uses: hbelmiro/uv-lock-check@v1
   with:
-    requirements-command: 'uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt'
+    command: 'uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt'
     requirements-path: 'requirements-linux.txt'
 ```
 
@@ -84,13 +84,13 @@ jobs:
 - name: Check Linux Requirements
   uses: hbelmiro/uv-lock-check@v1
   with:
-    requirements-command: 'uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt'
+    command: 'uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt'
     requirements-path: 'requirements-linux.txt'
 
 - name: Check Windows Requirements
   uses: hbelmiro/uv-lock-check@v1
   with:
-    requirements-command: 'uv pip compile --python-platform=windows pyproject.toml -o requirements-win.txt'
+    command: 'uv pip compile --python-platform=windows pyproject.toml -o requirements-win.txt'
     requirements-path: 'requirements-win.txt'
 ```
 

action.yaml

@@ -13,8 +13,8 @@ inputs:
     description: 'Path to the requirements.txt file. If empty, will look for requirements.txt in the same directory as pyproject.toml'
     required: false
     default: ''
-  requirements-command:
-    description: 'Complete uv command to generate requirements.txt (e.g., "uv pip compile --python-platform=linux pyproject.toml -o requirements-linux.txt")'
+  command:
+    description: 'uv command to run for validation (e.g., "uv sync" for lock files, "uv pip compile pyproject.toml -o requirements.txt" for requirements)'
     required: false
     default: 'uv sync'
   run-sync:
@@ -65,12 +65,12 @@ runs:
       run: |
         uv sync
         if [ -f "${{ env.REQUIREMENTS_PATH }}" ]; then
-          ${{ inputs.requirements-command }}
+          ${{ inputs.command }}
         fi
 
     - name: Verify files
       shell: bash
       working-directory: ${{ env.PYPROJECT_DIR }}
       env:
-        SYNC_COMMAND: ${{ inputs.requirements-command }}
+        COMMAND: ${{ inputs.command }}
       run: $GITHUB_ACTION_PATH/verify.sh

verify.sh

@@ -4,19 +4,19 @@ set -euo pipefail
 
 # Always resolve relative to the repo root (GITHUB_WORKSPACE or git rev-parse fallback)
 REPO_ROOT="${GITHUB_WORKSPACE:-$(git rev-parse --show-toplevel 2>/dev/null)}"
-if [[ "$SYNC_COMMAND" =~ --directory[=\ ]([^ ]+) ]]; then
+if [[ "$COMMAND" =~ --directory[=\ ]([^ ]+) ]]; then
   DIR_ARG="${BASH_REMATCH[1]}"
   # If DIR_ARG is not absolute, make it absolute relative to repo root
   if [[ ! "$DIR_ARG" = /* ]]; then
     ABS_DIR_ARG="$REPO_ROOT/$DIR_ARG"
-    SYNC_COMMAND="${SYNC_COMMAND/--directory $DIR_ARG/--directory $ABS_DIR_ARG}"
-    SYNC_COMMAND="${SYNC_COMMAND/--directory=$DIR_ARG/--directory=$ABS_DIR_ARG}"
+    COMMAND="${COMMAND/--directory $DIR_ARG/--directory $ABS_DIR_ARG}"
+    COMMAND="${COMMAND/--directory=$DIR_ARG/--directory=$ABS_DIR_ARG}"
   fi
 fi
 
-echo "Resolved SYNC_COMMAND: $SYNC_COMMAND"
-echo "Running sync command: $SYNC_COMMAND"
-eval "$SYNC_COMMAND"
+echo "Resolved COMMAND: $COMMAND"
+echo "Running command: $COMMAND"
+eval "$COMMAND"
 
 # Check if any existing files have been modified
 if ! git diff --exit-code --quiet; then