neokapi/Kapi Run
Run kapi commands — catch up translations, gate content quality, plan cost — and deliver the results as a commit or pull request
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| command | Kapi subcommand to execute | no | up |
| args | Additional arguments | no | "" |
| project | Path to the kapi.yaml recipe (-p flag) | no | "" |
| plan | With `command: up`, dry-run instead: report pending work, TM leverage, and a token estimate without writing anything or calling a provider. Pairs with `pr-comment` to post the cost of a change on its PR. | no | false |
| fail-on-parked | With `command: up`, fail the workflow when the run parks (work remains that the loop could not carry to the ship gate). Parked is normal pending work, not a broken run, so the default is to commit what it caught up and annotate the rest. | no | false |
| commit | Whether to commit translation changes | no | true |
| commit-message | Commit message | no | chore: update translations via kapi |
| create-pull-request | Deliver changes as a pull request instead of pushing to the current branch. Needs `permissions: pull-requests: write` (plus contents: write). | no | false |
| pr-title | Title for the created pull request | no | chore: update translations via kapi |
| pr-labels | Comma-separated labels for the created pull request | no | translations,kapi |
| pr-base | Base branch for the created pull request (empty = repository default branch) | no | "" |
| branch-prefix | Branch name prefix for pull-request delivery | no | kapi/up |
| pr-comment | On pull-request events, post one sticky comment with the report (plan, `kapi up` outcome, or gate result) that re-runs update in place. Needs `permissions: pull-requests: write`. | no | false |
| token | GitHub token for PR creation and comments | no | ${{ github.token }} |
| git-user-name | Git committer name | no | Kapi Bot |
| git-user-email | Git committer email | no | bot@kapi.dev |
| paths | Space-separated paths to stage for commit | no | "" |
Outputs
| name | description |
|---|---|
| status | Run result: success, no-changes, or failed |
| outcome | With `command: up`: `converged` or `parked` (empty for other commands) |
| passes | With `command: up`: how many reconciliation passes the run took |
| parked-locales | With `command: up`: comma-separated locales still short of their gate |
| gate | With `command: check`: `pass` or `fail` |
| plan-missing | With `plan: true`: pending units across all locales |
| plan-tm-exact | With `plan: true`: units recoverable from TM exact hits |
| plan-ai-remaining | With `plan: true`: units left for AI translation |
| plan-token-estimate | With `plan: true`: estimated tokens for the remaining units |
| committed | Whether a commit was created |
| commit-sha | SHA of the created commit (empty if no commit) |
| pull-request-url | URL of the created pull request (empty if none) |