An open API service indexing awesome lists of open source software.

https://github.com/artemrys/workflow-splunk-addon

GitHub reusable workflow to build and test Splunk add-ons
https://github.com/artemrys/workflow-splunk-addon

github github-actions reusable-workflows splunk

Last synced: 10 months ago
JSON representation

GitHub reusable workflow to build and test Splunk add-ons

Awesome Lists containing this project

README

          

# GitHub reusable workflow to support Splunk add-ons

This repository provides a reusable workflow to build and appinspect Splunk add-ons. It uses [`ucc-gen`](https://github.com/splunk/addonfactory-ucc-generator) and [`slim`](https://pypi.org/project/splunk-packaging-toolkit/) to create a ready to be installed add-on.

Then it uses [Splunk Appinspect CLI GitHub Action](https://github.com/splunk/appinspect-cli-action) to validate the generated add-on and optionally uses [Splunk Appinspect API GitHub Action](https://github.com/splunk/appinspect-api-action) if both `SPLUNKBASE_USER` and `SPLUNKBASE_PASSWORD` secrets are passed to the reusable workflow.

## Usage

```
name: build

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
build:
uses: artemrys/workflow-splunk-addon/.github/workflows/reusable-build-release.yaml@v0.2.0
```

### Inputs

* [optional] `ucc_gen_version` - specify version of [`ucc-gen`](https://github.com/splunk/addonfactory-ucc-generator)

### Secrets

* [optional] `SPLUNKBASE_USER` - Splunkbase username
* [optional] `SPLUNKBASE_PASSWORD` - Splunkbase password