Add buf policy YAML file config #3769
Conversation
|
The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).
|
| testReadWriteBufPolicyYAMLFileRoundTrip( | ||
| t, | ||
| // input | ||
| `version: v2 |
There was a problem hiding this comment.
Curious, this is the first policy file version, why we're starting at v2?
There was a problem hiding this comment.
The file will consume v2 lint/breaking config options, so we went with v2 to clarify its related to the v2 spec.
There was a problem hiding this comment.
I don't think buf_policy_yaml_file.go should live under bufpkg/bufconfig, because it is not a a configuration file for buf. It is much closer in nature to bufremotepluginconfig (https://github.com/bufbuild/buf/tree/main/private/bufpkg/bufremoteplugin/bufremotepluginconfig) where it is the configuration of an specific entity. In this case, it is also the content of said entity. So I would move the policy YAML under bufpolicy as a sub-package, bufpolicyconfig, and go from there (policy_config.go and the changes to buf.yaml would stay in bufconfig).
| } | ||
| ) | ||
|
|
||
| // BufPolicyYAMLFile represents a buf.policy.yaml file. |
There was a problem hiding this comment.
Instead of buf.policy.yaml, could we say something like:
BufPolicyYAMLFile represents a policy configuration YAML file.
Just because this is meant to be generic.
This adds support for buf policy configuration. A new field in
buf.yamlfiles (policies) takes an array ofPolicyConfigand a new external file typeBufPolicyYAMLFilefor defining a policy.