Rename parameter from git-lfs to lfs and add integration test

Co-authored-by: JamesIves <10888441+JamesIves@users.noreply.github.com>

Author: Copilot

.gitattributes

@@ -0,0 +1 @@
+integration/large-file.bin filter=lfs diff=lfs merge=lfs -text

.github/workflows/integration.yml

@@ -359,3 +359,30 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branches: gh-pages
+
+  # Deploys using Git LFS support for large files.
+  integration-lfs:
+    needs: integration-root-folder
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5.0.0
+        with:
+          persist-credentials: false
+          lfs: true
+
+      - name: Build and Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: integration
+          target-folder: cat/lfs-test
+          lfs: true
+          silent: false
+          git-config-name: Montezuma
+          git-config-email: montezuma@jamesiv.es
+
+      - name: Cleanup Generated Branch
+        uses: dawidd6/action-delete-branch@v3.1.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branches: gh-pages

README.md

@@ -113,7 +113,7 @@ By default, the action does not need any token configuration and uses the provid
 | `single-commit`    | This option can be toggled to `true` if you'd prefer to have a single commit on the deployment branch instead of maintaining the full history. **Using this option will also cause any existing history to be wiped from the deployment branch**.                                                                                                                           | `with` | **No**   |
 | `force`            | Force-push new deployments to overwrite the previous version; otherwise, attempt to rebase new deployments onto any existing ones. This option is turned on by default and can be toggled off by setting it to `false`, which may be useful if there are multiple deployments in a single branch.                                                                           | `with` | **No**   |
 | `attempt-limit`    | How many rebase attempts to make before suspending the job. This option defaults to `3` and may be useful to increase when there are multiple deployments in a single branch.                                                                                                                                                                                               | `with` | **No**   |
-| `git-lfs`          | Enable Git Large File Storage (LFS) support for handling large files. This should be set to `true` if your deployment folder contains files tracked by Git LFS. Defaults to `false`.                                                                                                                                                                                    | `with` | **No**   |
+| `lfs`              | Enable Git Large File Storage (LFS) support for handling large files. This should be set to `true` if your deployment folder contains files tracked by Git LFS. Defaults to `false`.                                                                                                                                                                                    | `with` | **No**   |
 | `silent`           | Silences the action output preventing it from displaying git messages.                                                                                                                                                                                                                                                                                                      | `with` | **No**   |
 | `tag`              | Add a tag to the commit. Only works when `dry-run` is not used.                                                                                                                                                                                                                                                                                                             | `with` | **No**   |
 
@@ -135,17 +135,17 @@ This value is also set as a step output as `deployment-status`.
 
 ### Using Git Large File Storage (LFS) 📦
 
-If your project contains files larger than 100MB, you'll need to use [Git Large File Storage (LFS)](https://git-lfs.github.com/) to avoid GitHub's file size limits. This action supports LFS files when the `git-lfs` input is set to `true`.
+If your project contains files larger than 100MB, you'll need to use [Git Large File Storage (LFS)](https://git-lfs.github.com/) to avoid GitHub's file size limits. This action supports LFS files when the `lfs` input is set to `true`.
 
 ```yml
 - name: Deploy to GitHub Pages
   uses: JamesIves/github-pages-deploy-action@v4
   with:
     folder: build
-    git-lfs: true
+    lfs: true
 ```
 
-When `git-lfs` is enabled, the action will:
+When `lfs` is enabled, the action will:
 1. Install and configure Git LFS in the deployment environment
 2. Properly handle LFS pointer files during the deployment process
 3. Ensure large files are correctly pushed to GitHub Pages

action.yml

@@ -95,7 +95,7 @@ inputs:
     required: false
     default: 3
 
-  git-lfs:
+  lfs:
     description: 'Enable Git Large File Storage (LFS) support for handling large files. This should be set to true if your deployment folder contains files tracked by Git LFS.'
     required: false
     default: false

integration/large-file.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:30e14955ebf1352266dc2ff8067e68104607e750abb9d3b36582b8af909fcb58
+size 1048576

src/constants.ts

@@ -99,8 +99,8 @@ export const action: ActionInterface = {
   force: !isNullOrUndefined(getInput('force'))
     ? getInput('force').toLowerCase() === 'true'
     : true,
-  gitLfs: !isNullOrUndefined(getInput('git-lfs'))
-    ? getInput('git-lfs').toLowerCase() === 'true'
+  gitLfs: !isNullOrUndefined(getInput('lfs'))
+    ? getInput('lfs').toLowerCase() === 'true'
     : false,
   attemptLimit: !isNullOrUndefined(getInput('attempt-limit'))
     ? parseInt(getInput('attempt-limit'), 10)