devhelmhq/setup-devhelm GitHub Action installs the DevHelm CLI and authenticates it in your workflow. Use it to validate, test, and deploy monitoring configurations as part of your CI/CD pipeline.
Basic usage
Inputs
¹
api-token is technically optional so the action can be used to install the CLI without authenticating (e.g. devhelm --version smoke test). Required for any command that hits the API.
Outputs
PR preview workflow
Show a deployment plan on pull requests:Gated deploy with dry-run
Use--detailed-exitcode to gate deploys based on whether changes exist:
10 means changes are pending; exit code 0 means no changes.
Multi-environment setup
Deploy different configs per environment using matrix or branch conditions:Secrets setup
- Go to your GitHub repository → Settings → Secrets and variables → Actions
- Add
DEVHELM_API_TOKENwith your DevHelm API key - For multi-environment setups, add per-environment tokens (e.g.,
DEVHELM_TOKEN_STAGING,DEVHELM_TOKEN_PRODUCTION)
Next steps
YAML file format
Learn the devhelm.yml schema and resource sections.
Deploy workflow
Understand the validate → plan → deploy lifecycle.
Multi-environment
Configure staging vs production deploys.
Generic CI
Use the CLI in GitLab, Jenkins, and other CI systems.