Plugins
Importing a plugin repository
By default trunk imports the trunk-io/plugins repository. To import a repo add it to the plugins.sources
list. Each repo requires a URI and ref.
Field | Description |
---|---|
| unique identifier for this repository |
| address used to clone the target repository |
| commit id or tag to checkout. Do not use branch names, as these can be unstable |
| path to local (on-disk) repository. Takes precedence over uri/ref if defined |
| import content into the global namespace. If set to false actions and linters defined in the plugin must be referenced by |
Plugin capabilities
Any configuration used in trunk.yaml
can also be used in a plugin repository, with some exceptions. A plugin repository must have one root level plugin.yaml
and can have any number of other plugin.yaml
files in other subdirectories. These configuration files are then merged into one composite plugin configuration.
The most common use for a plugin repository is to define custom linters, actions, or tools. But they can also be used to define a common set of shared tools across an organization. For more info, see organization configs.
The root plugin.yaml
file may also have a required_trunk_version
field which governs compatibility when upgrading between CLI versions.
Add a plugin to your trunk.yaml
file
trunk.yaml
fileTo add a plugin from GitHub:
To add a plugin from GitHub at a specific version:
To add a plugin from a local repository:
Note that when specifying a remote plugin, the ref
field must be a tag or SHA.
Plugins scope
Plugins are merged serially, in the order that they are sourced, and can override almost any Trunk configuration. This allows organizations to provide a set of overrides and definitions in one central place.
For instance, you can create your own my-plugins
repository with plugin.yaml
:
sourced in a .trunk/trunk.yaml
file from another repository as follows:
When a user runs trunk
in the sourcing repository, they will already have ruff
enabled, along with the trufflehog
override from the my-plugins
repository.
Note that private GitHub plugin repositories are not currently supported.
Excluded fields
Plugin sources
, as well as the cli
version
, are not merged from plugin repositories to ensure
that config merging occurs in a predictable, stable fashion.
Last updated