init

Author: ziegfried

.gitignore

@@ -0,0 +1 @@
+node_modules

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Splunk Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,2 +1,35 @@
-# appinspect-api-action
-GitHub action to validation a Splunk app package using the AppInspect API
+# App Inspect API GitHub Action
+
+Simple GitHub action to validation a Splunk app package using AppInspect. This action uses the [Splunkbase AppInspect API](https://dev.splunk.com/enterprise/docs/developapps/testvalidate/appinspect/runappinspectrequestsapi).
+
+There is also an [alternative GitHub action using the AppInspect CLI](https://github.com/splunk/appinspect-cli-action).
+
+## Example Usage
+
+```yaml
+jobs:
+    some-job:
+        runs-on: ubuntu-latest
+        steps:
+            # ...
+            - uses: splunk/appinspect-api-action@v1
+              with:
+                  filePath: ./dist/myapp.tar.gz
+                  splunkUser: ${{ secrets.SPLUNKBASE_USER }}
+                  splunkPassword: ${{ secrets.SPLUNKBASE_PASSWORD }}
+                  includedTags: cloud
+```
+
+## 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 |
+
+### Tags
+
+For more info on tags see [Splunk AppInspect tag reference](https://dev.splunk.com/enterprise/docs/reference/appinspecttagreference).

action.yml

@@ -0,0 +1,22 @@
+name: App Inspect
+description: Run Splunk AppInspect for a splunk app bundle
+author: Splunk
+runs:
+    using: node12
+    main: dist/index.js
+inputs:
+    filePath:
+        description: Path to the app bundle file (.tar.gz or .spl)
+        required: true
+    splunkUser:
+        description: Splunk.com user used to login to the appinspect API
+        required: true
+    splunkPassword:
+        description: Splunk.com password used to login to the appinspect API
+        required: true
+    includedTags:
+        description: Comma separated list of tags to include in appinspect job
+        required: false
+    excludedTags:
+        description: Comma separated list of tags to exclude from appinspect job
+        required: false