upload html report as github actions artifact

splunk · May 12, 2021 · 49f71cd · 49f71cd
1 parent 95700b1
commit 49f71cd
Show file tree

Hide file tree

Showing 7 changed files with 10,326 additions and 2,901 deletions.
diff --git a/README.md b/README.md
@@ -24,16 +24,18 @@ jobs:
 
 ## Inputs
 
-| Name             | Description                                                                                                       |
-| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
-| `filePath`       | Path to the app bundle file (.tar.gz or .spl)                                                                     |
-| `splunkUser`     | Splunk.com user used to login to the appinspect API                                                               |
-| `splunkPassword` | Splunk.com password used to login to the appinspect API                                                           |
-| `includedTags`   | Optional: Comma separated list of [tags](#tags) to include in appinspect job                                      |
-| `excludedTags`   | Optional: Comma separated list of [tags](#tags) to exclude from appinspect job                                    |
-| `failOnError`    | Optional: If enabled the action will fail when errors or failures are reported by AppInspect (enabled by default) |
-| `failOnWarning`  | Optional: If enabled the action will fail when warnings are reported by AppInspect                                |
-
-### Tags
-
-For more info on tags see [Splunk AppInspect tag reference](https://dev.splunk.com/enterprise/docs/reference/appinspecttagreference).
+| Name                   | Description                                                                                                | Notes            |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------- |
+| `filePath`             | Path to the app bundle file (.tar.gz or .spl)                                                              | **required**     |
+| `splunkUser`           | Splunk.com user used to login to the appinspect API                                                        | **required**     |
+| `splunkPassword`       | Splunk.com password used to login to the appinspect API                                                    | **required**     |
+| `includedTags`         | Comma separated list of [tags](#reference-docs) to include in appinspect job                               |                  |
+| `excludedTags`         | Comma separated list of [tags](#reference-docs) to exclude from appinspect job                             |                  |
+| `failOnError`          | If enabled the action will fail when errors or failures are reported by AppInspect                         | default: `true`  |
+| `failOnWarning`        | If enabled the action will fail when warnings are reported by AppInspect                                   | default: `false` |
+| `ignoredChecks`        | Comma separated list of [check names](#reference-docs) to explicitly ignore                                |                  |
+| `uploadReportArtifact` | If enabled the action will upload the HTML report from the AppInspect API as an artifact to GitHub actions | default: `true`  |
+
+### Reference Docs
+
+For more info on check critera, tags and the API see the [Splunk AppInspect reference](https://dev.splunk.com/enterprise/reference/appinspect).
diff --git a/action.yml b/action.yml
@@ -23,6 +23,15 @@ inputs:
     failOnError:
         description: If enabled the action will fail when errors or failures are reported by AppInspect (enabled by default)
         required: false
+        default: 'true'
     failOnWarning:
         description: If enabled the action will fail when warnings are reported by AppInspect
         required: false
+        default: 'false'
+    ignoredChecks:
+        description: Comma separated list of check names to explicitly ignore
+        required: false
+    uploadReportArtifact:
+        description: If enabled the action will upload the HTML report from the AppInspect API as an artifact to GitHub actions (enabled by default)
+        required: false
+        default: 'true'