Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
ziegfried committed Apr 21, 2021
1 parent ec8b744 commit cfca534
Show file tree
Hide file tree
Showing 12 changed files with 5,095 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
22 changes: 22 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -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
Loading

0 comments on commit cfca534

Please sign in to comment.