feat: Use git-diff files and allow negative patterns (#97)

Author: IAreKyleW00t

.github/workflows/test.yml

@@ -26,11 +26,6 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          sparse-checkout: |
-            dist
-            src
-            README.md
 
       - name: Create test branch
         id: branch
@@ -44,8 +39,11 @@ jobs:
         run: |
           echo -e "\n### $(date -Iseconds)" | tee -a README.md
           date -Iseconds | tee date.txt
+          date -Iseconds | tee test-ignore.txt
+          echo "$GITHUB_RUN_ID" | tee __tests__/ignore/test-abcdef.txt
           echo "$GITHUB_RUN_ID" | tee src/test.txt
           echo "$GITHUB_RUN_ID" | tee src/test2.txt
+          echo "uncommitted file" | tee blah.txt
           mkdir -p "$TEST_BRANCH"
           for i in {1..4}; do
             echo "$i-$GITHUB_RUN_ID" | tee "$TEST_BRANCH/$i-$GITHUB_RUN_ID"
@@ -60,19 +58,12 @@ jobs:
           files: |
             README.md
             date.txt
-            src/test.txt
+            !src/test.txt
             src/*.txt
+            __tests__/**
+            !${{ env.TEST_BRANCH }}/1-*
             ${{ env.TEST_BRANCH }}/**
 
-      - name: Update test branch locally
-        shell: bash
-        run: |
-          rm  README.md
-          rm date.txt
-          rm src/*.txt
-          rm -r "$TEST_BRANCH"
-          git pull origin "$TEST_BRANCH"
-
       - name: Verify GPG signature
         shell: bash
         env:
@@ -88,12 +79,22 @@ jobs:
         env:
           COMMIT: ${{ steps.commit.outputs.commit }}
         run: |
+          git status
+
           FILES=$(git diff-tree --no-commit-id --name-only -r "$COMMIT")
-          echo "$FILES"
-          if [ "$(wc -l <<< "$FILES")" -ne 8 ]; then
+          echo -e "Changed files:\n$FILES"
+          if [ "$(wc -l <<< "$FILES")" -ne 6 ]; then
             echo "::error::Unexpected changes in commit"
             exit 1
           fi
+          echo
+
+          FILES=$(git diff --cached --name-only)
+          echo -e "Unchanged files:\n$FILES"
+          if [ "$(wc -l <<< "$FILES")" -ne 3 ]; then
+            echo "::error::Unexpected uncommit changes"
+            exit 1
+          fi
 
       - name: Delete test branch
         if: cancelled() == false

.gitignore

@@ -101,3 +101,5 @@ __tests__/runner/*
 .idea
 .vscode
 *.code-workspace
+
+test-ignore.txt

README.md

@@ -14,8 +14,10 @@ A GitHub Action to create signed and verified commits as the
 accomplished via the GitHub [REST API] by using the [Blob] and [Tree] endpoints
 to build the commit and update the original Ref to point to it. [^1]
 
-The resulting commit will be signed and verified using
-[GitHub's public PGP key](https://github.com/web-flow.gpg)!
+After using this Action your local branch will be updated to point to the newly
+created commit, which will be signed and verified using
+[GitHub's public PGP key](https://github.com/web-flow.gpg)! Files that were not
+committed by the Action will be left staged.
 
 > [!IMPORTANT]
 >
@@ -37,6 +39,7 @@ The resulting commit will be signed and verified using
       README.md
       *.txt
       src/**/tests/*
+      !test-data/dont-include-this
       test-data/**
 ```
 
@@ -52,19 +55,21 @@ The resulting commit will be signed and verified using
 >   example.txt
 > ```
 
-| Name              | Type   | Description                                      | Default                   |
-| ----------------- | ------ | ------------------------------------------------ | ------------------------- |
-| `ref`             | String | The ref to push the commit to                    | `${{ github.ref }}`       |
-| `files`           | List   | Files/[Glob] patterns to include with the commit | _required_                |
-| `message`         | String | Message for the commit [1]                       | _optional_                |
-| `message-file`    | String | File to use for the commit message [1]           | _optional_                |
-| `force-push`      | String | Force push the commit                            | `false`                   |
-| `follow-symlinks` | String | Follow symbolic links when globbing files        | `true`                    |
-| `workspace`       | String | Directory containing checked out files           | `${{ github.workspace }}` |
-| `token`           | String | GitHub Token for REST API access [2]             | `${{ github.token }}`     |
-
-> 1. You must include either `message` or `message-file` (which takes priority).
-> 2. This Action is intended to work with the default `GITHUB_TOKEN`. See the
+| Name              | Type    | Description                                          | Default                   |
+| ----------------- | ------- | ---------------------------------------------------- | ------------------------- |
+| `ref`             | String  | The ref to push the commit to                        | `${{ github.ref }}`       |
+| `files`           | List    | Files/[Glob] patterns to include with the commit [1] | _required_                |
+| `message`         | String  | Message for the commit [2]                           | _optional_                |
+| `message-file`    | String  | File to use for the commit message [2]               | _optional_                |
+| `force-push`      | Boolean | Force push the commit                                | `false`                   |
+| `follow-symlinks` | Boolean | Follow symbolic links when globbing files            | `true`                    |
+| `workspace`       | String  | Directory containing checked out files               | `${{ github.workspace }}` |
+| `token`           | String  | GitHub Token for REST API access [3]                 | `${{ github.token }}`     |
+
+> 1. Files within your `.gitignore` will not be included. You can also negate
+>    any files by prefixing it with `!`
+> 2. You must include either `message` or `message-file` (which takes priority).
+> 3. This Action is intended to work with the default `GITHUB_TOKEN`. See the
 >    [notice](#verified-bot-commit-action) and [limitations](#limitations)
 
 ### Outputs

__tests__/ignore/.gitignore

@@ -0,0 +1 @@
+test-abcdef.txt