Improve action description (#1)

## what * Improve action description * Update node * Update npm packages ## why * Have nice readme * Avoid depreciation messages
cloudposse · Nov 23, 2023 · 02c9afb · 02c9afb
1 parent 66b0edf
commit 02c9afb
Show file tree

Hide file tree

Showing 354 changed files with 35,805 additions and 1,611 deletions.
diff --git a/.github/workflows/auto-readme.yml b/.github/workflows/auto-readme.yml
@@ -62,7 +62,7 @@ jobs:
           body: |-
             ## what
             This is an auto-generated PR that updates the README.md and docs
-            
+
             ## why
             To have most recent changes of README.md and doc from origin templates
 
@@ -72,4 +72,4 @@ jobs:
           labels: |
             auto-update
             no-release
-            readme
+            readme
diff --git a/.github/workflows/feature-branch.yml b/.github/workflows/feature-branch.yml
@@ -12,4 +12,4 @@ jobs:
       repository: "${{ github.event.repository.name }}"
       ref: "${{ github.event.pull_request.head.ref  }}"
     secrets:
-      github-private-actions-pat: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
+      github-private-actions-pat: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
diff --git a/.github/workflows/test-negative.yml b/.github/workflows/test-negative.yml
@@ -4,7 +4,7 @@ on:
   #  #
   #  # Added pull_request to register workflow from the PR.
   #  # Read more https://stackoverflow.com/questions/63362126/github-actions-how-to-run-a-workflow-created-on-a-non-master-branch-from-the-wo
-  pull_request: {}
+  # pull_request: {}
   workflow_dispatch: {}
 
 jobs:

diff --git a/.github/workflows/test-positive.yml b/.github/workflows/test-positive.yml
@@ -4,7 +4,7 @@ on:
 #  #
 #  # Added pull_request to register workflow from the PR.
 #  # Read more https://stackoverflow.com/questions/63362126/github-actions-how-to-run-a-workflow-created-on-a-non-master-branch-from-the-wo
-  pull_request: {}
+#  pull_request: {}
   workflow_dispatch: {}
 
 jobs:

diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
 .build-harness
-build-harness
+build-harness
diff --git a/.licenses/npm/@actions/core.dep.yml b/.licenses/npm/@actions/core.dep.yml
diff --git a/.licenses/npm/@actions/exec.dep.yml b/.licenses/npm/@actions/exec.dep.yml
diff --git a/.licenses/npm/@actions/http-client.dep.yml b/.licenses/npm/@actions/http-client.dep.yml
diff --git a/.licenses/npm/@actions/io.dep.yml b/.licenses/npm/@actions/io.dep.yml
diff --git a/.licenses/npm/@actions/tool-cache.dep.yml b/.licenses/npm/@actions/tool-cache.dep.yml
diff --git a/.licenses/npm/@fastify/busboy.dep.yml b/.licenses/npm/@fastify/busboy.dep.yml
diff --git a/.licenses/npm/semver.dep.yml b/.licenses/npm/semver.dep.yml
diff --git a/.licenses/npm/undici.dep.yml b/.licenses/npm/undici.dep.yml
diff --git a/.licenses/npm/uuid.dep.yml → .licenses/npm/uuid-3.4.0.dep.yml b/.licenses/npm/uuid.dep.yml → .licenses/npm/uuid-3.4.0.dep.yml
diff --git a/.licenses/npm/uuid-8.3.2.dep.yml b/.licenses/npm/uuid-8.3.2.dep.yml
diff --git a/README.md b/README.md
@@ -96,18 +96,18 @@ It's 100% Open Source and licensed under the [MIT](LICENSE).
 
 | Name | Description | Default | Required |
 |------|-------------|---------|----------|
-| compact | compact | false | false |
-| input | input | N/A | true |
-| raw-output | raw-output | false | false |
-| remove-trailing-newline | remove-trailing-newline | true | false |
-| script | script | N/A | true |
+| compact | Compact instead of pretty-printed output | false | false |
+| input | JSON formated string | N/A | true |
+| raw-output | Output raw strings, not JSON texts | false | false |
+| remove-trailing-newline | Remove trailing newline | true | false |
+| script | JQ query string | N/A | true |
 
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| output | output from the jq command |
+| output | Output from the jq command |
 <!-- markdownlint-restore -->
 
 

diff --git a/README.yaml b/README.yaml
@@ -43,7 +43,7 @@ usage: |-
     jobs:
       example:
         outputs:
-          result: "${{ steps.current.outputs.output }}"  
+          result: "${{ steps.current.outputs.output }}"
         steps:
           - uses: cloudposse/github-action-jq@main
             id: current

diff --git a/action.yml b/action.yml
@@ -2,23 +2,28 @@ name: 'JQ Script'
 description: 'Run JQ on a JSON value'
 inputs:
   input:
+    description: JSON formated string
     required: true
   script:
+    description: JQ query string
     required: true
   compact:
+    description: Compact instead of pretty-printed output
     required: false
     default: 'false'
   raw-output:
+    description: Output raw strings, not JSON texts
     required: false
     default: 'false'
   remove-trailing-newline:
+    description: Remove trailing newline
     required: false
     default: 'true'
 outputs:
   output:
-    description: 'output from the jq command'
+    description: Output from the jq command
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'index.js'
 branding:
   icon: chevron-right

diff --git a/docs/github-action.md b/docs/github-action.md
@@ -4,16 +4,16 @@
 
 | Name | Description | Default | Required |
 |------|-------------|---------|----------|
-| compact | compact | false | false |
-| input | input | N/A | true |
-| raw-output | raw-output | false | false |
-| remove-trailing-newline | remove-trailing-newline | true | false |
-| script | script | N/A | true |
+| compact | Compact instead of pretty-printed output | false | false |
+| input | JSON formated string | N/A | true |
+| raw-output | Output raw strings, not JSON texts | false | false |
+| remove-trailing-newline | Remove trailing newline | true | false |
+| script | JQ query string | N/A | true |
 
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| output | output from the jq command |
+| output | Output from the jq command |
 <!-- markdownlint-restore -->
diff --git a/...tions/tool-cache/node_modules/.bin/semver → node_modules/.bin/semver b/...tions/tool-cache/node_modules/.bin/semver → node_modules/.bin/semver
diff --git a/node_modules/.bin/uuid b/node_modules/.bin/uuid