vatsaljagani/Generate App Build, App Inspect Check and Splunk App Utilities

Automatically generate Splunk App/Add-on builds, and run app-inspect checks. Optionally add common Splunk App utilities.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
app_dir	Provide app directory inside your repository. Do not provide a value if the repo's root directory itself is the app directory.	no	.
to_make_permission_changes	Whether to apply file and folder permission changes according to Splunk App Inspect expectation before generating the build.	no	false
use_ucc_gen	Use ucc-gen command to generate the build for Add-ons. The 'app_dir' folder must have a sub-folder named 'package' and a file named 'globalConfig.json' for this to work.	no	false
is_remove_not_allowed_executables_from_lib	Remove files with mimetype application/x-executable or application/x-sharedlib from UCC build output lib/ folder before packaging.	no	false
python_requirements_file	Path to the requirements.txt file for Python dependency management. Path is relative to the app_dir. When provided, dependencies will be installed before generating the build. This allows using GitHub Dependabot for automatic dependency updates.	no	""
splunk_python_version	Python version to target when installing dependencies from python_requirements_file. Should match the Python version used by the Splunk platform (default: 3.13).	no	3.13
is_app_inspect_check	Whether to perform the Splunk app-inspect checks or not. This would include cloud-inspect checks as well.	no	true
splunkbase_username	Username required to call the Splunkbase API for App-Inspect. Required when is_app_inspect_check is set to true.	no	—
splunkbase_password	Password required to call the Splunkbase API for App-Inspect. Required when is_app_inspect_check is set to true. Strongly recommend to use via GitHub secrets only and specify like `{{secrets.MY_SPLUNK_PASSWORD}}`.	no	—
local_app_inspect	Use local Splunk App Inspect validation with splunk-appinspect Python library instead of the Splunkbase API. This is faster but may not be as up-to-date as the Splunkbase API. When enabled, splunkbase_username and splunkbase_password are not required.	no	false
fail_on	Control when the action should fail based on AppInspect results. Options: 'errors' (fail on errors only), 'warnings' (fail on warnings or errors), 'none' (never fail based on results).	no	errors
app_utilities	Add comma separated list of utilities to use. You need to enable read and write permission for workflow to create Pull Requests. Valid options: whats_in_the_app, logger, common_js_utilities, ucc_additional_packaging	no	""
my_github_token	GitHub token to create pull requests for app utilities. OPTIONAL when workflow has 'contents: write' and 'pull-requests: write' permissions - the action will automatically use the workflow's GITHUB_TOKEN. Only needed if you want to use a Personal Access Token (PAT) instead.	no	""
logger_log_files_prefix	Log files prefix. Only required for logger utility.	no	NONE
logger_sourcetype	Sourcetype for the internal app logs. Required only for logger utility.	no	NONE

Outputs

name	description
build_path	Full path to the generated build artifact (.tgz file)
artifact_name	Name of the generated build artifact (e.g., my_app_1.0.0_1.tgz)
app_package_id	The Splunk app package ID extracted from app.conf or globalConfig.json
app_version	The app version number extracted from app.conf or globalConfig.json
app_build_number	The app build number extracted from app.conf
app_inspect_status	Status of app-inspect check (Passed, Warning, Failure, Error, Timed-out, Exception, Skipped, or Not Run)
cloud_inspect_status	Status of cloud-inspect check (Passed, Warning, Failure, Error, Timed-out, Exception, Skipped, or Not Run)
ssai_inspect_status	Status of SSAI-inspect check (Passed, Warning, Failure, Error, Timed-out, Exception, Skipped, or Not Run)