Vulnesis/cli/config-apply action
The Vulnesis/cli/config-apply GitHub Action: inputs, outputs, permissions and a complete workflow with artifact upload and attestation.
Installs the CLI and applies Platform IaC documents through the config engine with --auto-approve, writing the output to the job summary.
steps:
- uses: actions/checkout@v5
- uses: Vulnesis/cli/config-apply@v4
with:
org-id: ${{ secrets.VULNESIS_ORG_ID }}
api-key: ${{ secrets.VULNESIS_API_KEY }}
Runs vulnetix config apply --auto-approve [-f <config-path>]... [--manager] [--prune]. The credential is the ApiKey of a developer or owner service account (org-id and api-key), or an Authentik access token in api-token. They reach the CLI only as environment variables. See Credentials.
Inputs
| Input | Description | Default |
|---|---|---|
version |
Release of the Vulnesis CLI to install. Empty installs the release this action ref was cut from, which is what a lock file or a SHA pin expects. An exact tag (v4.0.0), a major channel (v4) or latest float instead | - |
binary-path |
Path to an already-built vulnetix binary to use instead of downloading a release | - |
verify-provenance |
Verify the downloaded CLI against the signed SLSA provenance of its release with cosign, which this action installs: true or false. Every v4 release is signed; set false to install a v3 release that has no provenance.sigstore.json. The SHA-256 checksum is checked either way | true |
org-id |
Vulnesis organization ID (UUID), used with api-key. Optional: without credentials the CLI runs in community mode | - |
api-key |
Vulnesis API key. Passed to the CLI as VULNESIS_API_KEY, never on the command line | - |
api-token |
Vulnesis API token; the server resolves the organization. Passed as VULNESIS_API_TOKEN | - |
extra-args |
Extra arguments, one per line, so a value may contain spaces | - |
artifact-name |
Upload every file the command wrote as a workflow artifact with this name | - |
fail-on-findings |
Fail the step when the command exits non-zero (findings over a gate, a breach, an error): true or false. The artifact, attestation and publish steps run either way | true |
github-token |
Token for GitHub publishing, release assets and pull request comments | ${{ github.token }} |
attest |
Attest the written files with GitHub artifact attestations (needs id-token: write and attestations: write): true or false | false |
release-tag |
Attach every file the command wrote to the GitHub release with this tag (needs contents: write) | - |
config-path |
Config documents, one file or directory per line (default: .vulnetix/config) | - |
config-manager |
Manager the documents are declared by (default: gitops:<owner/repo> of this repository) | - |
config-prune |
Delete objects this manager owns that the documents no longer declare: true or false | false |
config-plan-hash |
Apply only if the plan still has this hash (passed as –plan-hash), the planHash a reviewed config-plan printed. A run whose plan has changed since is refused and writes nothing, so a scheduled or on-push apply can only repeat the plan that was reviewed | - |
Outputs
| Output | Description |
|---|---|
files |
Every file the command wrote, one per line |
sarif |
The SARIF files it wrote, one per line |
sbom |
The CycloneDX SBOM it wrote, if any |
manifest |
The artifact manifest (JSON Lines) listing what it wrote |
exit-code |
The command’s exit code |
result |
success or failure |
summary |
One line saying what ran and how it ended |
Permissions
contents: readto check out the repositoryid-token: writeandattestations: writewithattest: truecontents: writewithrelease-tag
Example workflow
name: Config apply
on:
push:
branches: [main]
paths: ['.vulnetix/**']
concurrency:
group: vulnetix-config
cancel-in-progress: false
jobs:
apply:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v5
- uses: Vulnesis/cli/config-apply@v4
with:
org-id: ${{ secrets.VULNESIS_ORG_ID }}
api-key: ${{ secrets.VULNESIS_API_KEY }}
config-prune: false
artifact-name uploads every file the command wrote as one workflow artifact. attest: true attests those files with GitHub artifact attestations.
Behaviour
- Each run plans again and applies only that fresh plan, so a push that races another push fails with a 409 instead of applying something nobody planned.
config-prune: truedeletes objects this manager owns that the documents no longer declare. Review a plan with it on before applying.- With no
config-path, no-fis passed: CLI v4 reads.vulnetix/configand the well-known files, soconfig-prune: trueadopts anAiFirewallPolicydeclared in.vulnetix/ai-firewall.yaml. Aconfig-pathis passed as-fand reads only what it names. See Migrating from v3 to v4. - A partial apply (HTTP 207, or an object that ended in phase
Failed) exits 1 and fails the step; the rest of the plan stays applied. - Exit code 3 means the plan has blocking conditions and nothing was applied:
resultisblocked. The exit codes are those of apply. - Use
config-planon pull requests and this action on the default branch. - The action needs
jqon the runner.