trunk-io/Trunk Check
The official trunk.io GitHub action
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| trunk-path | Path to Trunk Launcher. If not provided, we'll look for it the repo root, `.trunk/bin` and `tools/`. If it can't be found anywhere and is not provided explicitly, we'll download it on demand. | no | — |
| label | Label to append to the check run name (useful if running Trunk Check on multiple platforms) | no | — |
| arguments | Extra arguments to pass to trunk | no | — |
| check-mode | Trunk check mode. Leave unset to autodetect. Set to 'all' to check the entire repository. Set to 'populate_cache_only' in a dedicated workflow to populate the GitHub Actions cache with Trunk artifacts (see docs for more details). | no | — |
| check-all-mode | If set to "hold-the-line", computes new/existing issues by comparing to previous upload. | no | "" |
| check-run-id | Check run ID. If set, posts annotations using CheckService. | no | — |
| cache | Cache trunk downloads and results between runs. Caching is only needed when using ephemeral CI runners. | no | true |
| cache-key | A key unique to the repo/branch this action is being run on (e.g. the repo name and branch) | no | — |
| post-init | Steps to run after auto-init / before check | no | — |
| github-token | For overriding github.token | no | — |
| trunk-token | You can find a per-repo API token in the Trunk web app settings. This will cause results to be uploaded to the Trunk web app if this job is a scheduled job running on a branch, or if `check-mode` is set to 'all'. | no | — |
| upload-series | Upload series name, for when `trunk-token` is provided. If not provided, we'll use the branch name. | no | — |
| save-annotations | Save annotations as an artifact instead of posting them from this action. This is neccesary if your repository will be used with forks as they will will not have permissions to upload annotations. By default forks will be auto-detected. | no | auto |
| post-annotations | Post annotations previously uploaded with the `save-annotations` option (specific to posting annotations from forks). | no | false |
| setup-deps | Install dependencies for trunk check that the trunk CLI does not manage. This is only necessary if you have Node dependencies in your package.json that your Node linters need (e.g. eslint dependencies, or @types packages). | no | false |
| debug | Internal use only | no | false |
| timeout-seconds | Timeout seconds before we kill the long running trunk check process via unix timeout command. Default setting of 0 seconds disables the timeout. | no | 0 |
| cat-trunk-debug-logs | Option to cat .trunk/logs/cli.log && .trunk/logs/daemon.log | no | false |
| lfs-checkout | Option to checkout LFS files | no | true |
Outputs
no outputs