Migration Guide
Last updated
Last updated
The Code Quality dashboard in the Trunk web app has been deprecated, along with the ability to configure and manage CI workflows in the web app.
This means the Code Quality tab in the Trunk web app has been deprecated.
This deprecation impacts the following Code Quality features configured in the web app:
Checking for issues nightly.
Checking for issues on pull requests.
You only need to migrate if you have configured these features with the web app. You can check if you use these features through the web app in the Code Quality section of your repo settings.
Lastly, Trunk will no longer collect your linting issues. You will also stop receiving Slack notifications about new issues discovered by linters.
If you're using the --upload
flag on your trunk check
command, it will no longer work:
From both usage data and community feedback, we know the core value of Code Quality is in the CLI, IDE, and native CI integrations. We’ve deprecated some features to better support these key integrations with limited resources.
Nightly and PR jobs configured through the Trunk web app will no longer be supported. However, you can still run these checks by migrating these workflows to run as a step in your existing CI pipelines.
You will still receive inline comments about your errors if you run the action with the post-annotations
argument.
You can also set up checks on PR without using the provided GitHub action. Download the CLI in line and run the Code Quality CLI in CI mode to check a PR. Note that you will not receive inline arguments with this approach.
Here’s an example of the commands in a GitHub Actions workflow, but you can do the same in virtually any CI pipeline.
Specify the --all
flag on your trunk check
command to run on your entire codebase. Trunk is Git aware and checks only files changed in a PR by default. Specifying --all
will instead check the whole code base.
Here’s an example of the command in a GitHub Actions workflow. This command will also work in any other CI provider.
After you have migrated off the web app, you can manually turn off Check for issues in pull requests in your repo settings in the web app.
If you do not turn these off, you will continue to get warnings in your PRs until the services are shut down.
You can cache Trunk’s binary and install tools to speed up your CI runs. Trunk caches the version of trunk
itself, linters, formatters, and lint results in the ~/.cache/trunk
folder. Consult the documentation for your CI provider to learn about caching this folder.
Uploads and web reports based on Code Quality issues are no longer supported after this deprecation. These less-used features are deprecated so we can better maintain the core metalinter features of Code Quality. While an online report is no longer available, Trunk still produces standardized output by reformatting each linter’s output.
You will also stop receiving Slack notifications about new issues in your repo. Since Trunk no longer ingests uploads about your linter runs, it can’t send Slack notifications about them.
You can still run Code Quality in CI and on PRs. See the for step-by-step migration instructions.
Trunk provides a to help you lint your code in CI. You add it as a step to your workflows. To run on pull requests or on a schedule, you can configure the appropriate triggers for your workflow.
To run Trunk’s to lint your entire code base nightly or on a schedule, you can specify the `check-mode: all` argument when running the action.
If you have additional questions or concerns, please reach out to us on .