Renamed parameter debug to investigate.

pyTooling · Dec 26, 2024 · 3714994 · 3714994
1 parent c9927aa
commit 3714994
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/.github/actions/check-directory-content/action.yml b/.github/actions/check-directory-content/action.yml
@@ -78,7 +78,7 @@ runs:
           printf "%s" "Checking '${file}' ... "
           if [[ -f "$file" ]]; then
             printf "%s\n" "${ANSI_LIGHT_RED}[UNEXPECTED]${ANSI_NOCOLOR}"
-            printf "::error title=%s::%s\n" "check-directory-content" "File '${file}' is unexpected."
+            printf "::error title=%s::%s\n" "check-directory-content" "File '${file}' isn't expected."
             errors=$((errors + 1))
           else
             printf "%s\n" "${ANSI_LIGHT_GREEN}[PASSED]${ANSI_NOCOLOR}"

diff --git a/.github/workflows/ArtifactsUpload.yml b/.github/workflows/ArtifactsUpload.yml
@@ -52,12 +52,12 @@ jobs:
             bin/*.py
             lib/
 
-      - name: 📤 Upload artifact '${{ matrix.os.name }}-pyTooling-release' with debug
+      - name: 📤 Upload artifact '${{ matrix.os.name }}-pyTooling-release' with investigate
         uses: pyTooling/upload-artifact@dev
         continue-on-error: true
         with:
           name: ${{ matrix.os.name }}-pyTooling-release
-          debug: true
+          investigate: true
           path: |
             document1.txt
             *.log

diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ jobs:
 | `overwrite`                |    no    | `false`             | If true, an artifact with a matching name will be deleted before a new one is uploaded.<br/> If false, the action will fail if an artifact for the given name already exists.<br/> Does not fail if the artifact does not exist.                                                            |
 | `include-hidden-files`[^2] |    no    | `false`             | Whether to include hidden files in the provided path in the artifact.<br/> The file contents of any hidden files in the path should be validated before enabled this to avoid uploading sensitive information.                                                                              |
 | `mode`[^3]                 |    no    | `'tar'`             | Mode of operation. Allowed modes:<br/> • `tar` (default),<br/> • `legacy`                                                                                                                                                                                                                   |
-| `debug`                    |    no    | `false`             | Enabled debug mode. List content of the created tarball.                                                                                                                                                                                                                                    |
+| `investigate`              |    no    | `false`             | If enabled, list content of the created tarball.                                                                                                                                                                                                                                            |
 | `tarball-name`             |    no    | [^1]                | Filename of the embedded tarball.                                                                                                                                                                                                                                                           |
 
 [^1]: `'__pyTooling_upload_artifact__.tar'`

diff --git a/action.yml b/action.yml
@@ -86,9 +86,9 @@ inputs:
     type: string
     required: false
     default: 'tar'
-  debug:
+  investigate:
     description: |
-      Enabled debug mode. List content of the created tarball.
+      If enabled, list content of the created tarball.
     type: boolean
     required: false
     default: false
@@ -131,7 +131,7 @@ runs:
         ANSI_LIGHT_BLUE="\e[94m"
         ANSI_NOCOLOR=$'\x1b[0m'
 
-        if [[ "${{ inputs.debug }}" == "true" ]]; then
+        if [[ "${{ inputs.investigate }}" == "true" ]]; then
           printf "::group::${ANSI_LIGHT_BLUE}List all shell options via 'shopt' ...${ANSI_NOCOLOR}\n"
           shopt
           printf "::endgroup::\n"
@@ -276,8 +276,8 @@ runs:
         fi
 
     - name: List content of the generated tarball
-      id: debug
-      if: inputs.mode == 'tar' && inputs.debug == 'true'
+      id: investigate
+      if: inputs.mode == 'tar' && inputs.investigate == 'true'
       shell: bash
       run: |
         # List content of the generated tarball