Skip to content

Commit 49f71cd

Browse files
committed
upload html report as github actions artifact
1 parent 95700b1 commit 49f71cd

7 files changed

Lines changed: 10326 additions & 2901 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,18 @@ jobs:
2424
2525
## Inputs
2626
27-
| Name | Description |
28-
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
29-
| `filePath` | Path to the app bundle file (.tar.gz or .spl) |
30-
| `splunkUser` | Splunk.com user used to login to the appinspect API |
31-
| `splunkPassword` | Splunk.com password used to login to the appinspect API |
32-
| `includedTags` | Optional: Comma separated list of [tags](#tags) to include in appinspect job |
33-
| `excludedTags` | Optional: Comma separated list of [tags](#tags) to exclude from appinspect job |
34-
| `failOnError` | Optional: If enabled the action will fail when errors or failures are reported by AppInspect (enabled by default) |
35-
| `failOnWarning` | Optional: If enabled the action will fail when warnings are reported by AppInspect |
36-
37-
### Tags
38-
39-
For more info on tags see [Splunk AppInspect tag reference](https://dev.splunk.com/enterprise/docs/reference/appinspecttagreference).
27+
| Name | Description | Notes |
28+
| ---------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------- |
29+
| `filePath` | Path to the app bundle file (.tar.gz or .spl) | **required** |
30+
| `splunkUser` | Splunk.com user used to login to the appinspect API | **required** |
31+
| `splunkPassword` | Splunk.com password used to login to the appinspect API | **required** |
32+
| `includedTags` | Comma separated list of [tags](#reference-docs) to include in appinspect job | |
33+
| `excludedTags` | Comma separated list of [tags](#reference-docs) to exclude from appinspect job | |
34+
| `failOnError` | If enabled the action will fail when errors or failures are reported by AppInspect | default: `true` |
35+
| `failOnWarning` | If enabled the action will fail when warnings are reported by AppInspect | default: `false` |
36+
| `ignoredChecks` | Comma separated list of [check names](#reference-docs) to explicitly ignore | |
37+
| `uploadReportArtifact` | If enabled the action will upload the HTML report from the AppInspect API as an artifact to GitHub actions | default: `true` |
38+
39+
### Reference Docs
40+
41+
For more info on check critera, tags and the API see the [Splunk AppInspect reference](https://dev.splunk.com/enterprise/reference/appinspect).

action.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ inputs:
2323
failOnError:
2424
description: If enabled the action will fail when errors or failures are reported by AppInspect (enabled by default)
2525
required: false
26+
default: 'true'
2627
failOnWarning:
2728
description: If enabled the action will fail when warnings are reported by AppInspect
2829
required: false
30+
default: 'false'
31+
ignoredChecks:
32+
description: Comma separated list of check names to explicitly ignore
33+
required: false
34+
uploadReportArtifact:
35+
description: If enabled the action will upload the HTML report from the AppInspect API as an artifact to GitHub actions (enabled by default)
36+
required: false
37+
default: 'true'

0 commit comments

Comments
 (0)