brotni/Brotni Simulation
Register a GitHub pull request, commit, or OCI artifact as a candidate in an existing Brotni simulation campaign and publish a campaign-scoped check/comment back to GitHub. Registration is idempotent by candidate name.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| brotni-api-url | Base URL of the Brotni-compatible simulation API endpoint. Falls back to the BROTNI_API_URL environment variable. | no | — |
| brotni-token | Authentication token for the Brotni API. Falls back to the BROTNI_TOKEN environment variable. | no | — |
| execution-recipe | Path or URI of the execution recipe used to run this candidate. | no | — |
| artifact-uri | URI of the artifact to submit as a simulation candidate (e.g. an OCI image reference such as ghcr.io/org/image:tag). | no | — |
| artifact-digest | Content-addressable digest of the artifact (e.g. sha256:abc123...). Use this with artifact-uri to pin an immutable reference. | no | — |
| candidate-name | Human-readable name for this simulation candidate. | no | — |
| campaign-id | Brotni campaign ID to register this candidate with. Required — the action registers the build as a candidate in an existing campaign. | yes | — |
| candidate-label | PR label that marks a pull request as a campaign candidate for label-based discovery. | no | brotni-simulation-candidate |
| source-kind | Candidate source kind: git_change, container_image, or config_bundle. Inferred from the artifact inputs when omitted. | no | — |
| publish-comment | Post a campaign-scoped PR comment with this candidate's status and a link to the campaign comparison. Requires pull-requests: write and a pull_request event. | no | false |
| publish-check | Create a GitHub Check Run with the campaign-scoped result. Requires checks: write permission. | no | false |
| github-token | GitHub token used to post comments and check runs. Defaults to the automatically provided github.token. | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| candidate-id | Studio-minted identifier of the registered candidate. |
| campaign-url | URL to the campaign comparison view, when provided by the studio. |
| simulation-status | Candidate status: "registered" right after registration, or "passed" / "failed" once the campaign decision includes this candidate. |
| simulation-score | This candidate's overall score from the campaign decision, if available. |