buf.work.yaml
buf.work.yaml is used to define a workspace, which is an advanced local development feature. Workspaces make it possible to consolidate one or more modules into a single buildable unit. They also allow users to run buf operations across multiple modules with a single execution (such as buf lint)
| Type | object |
|---|---|
| File match |
buf.work.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/buf-work-yaml/latest.json |
| Source | https://www.schemastore.org/buf.work.json |
Validate with Lintel
npx @lintel/lintel checkbuf.work.yaml is used to define a workspace, which is an advanced local development feature. Workspaces make it possible to consolidate one or more modules into a single buildable unit. They also allow users to run buf operations across multiple modules with a single execution (such as buf lint).
Properties
Required. Defines the current configuration version. The only accepted value is v1.
Required. Lists the directories that define modules to be included in the workspace. The directory paths must be relative to the buf.work.yaml, and can't point to a location outside of the directory where your buf.work.yaml is.