Skip to content

Add documentation link to check annotation #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ckohnert wants to merge 2 commits into
base: main
Choose a base branch
from
+12 −0
Open

Add documentation link to check annotation #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0149657
Add documentation link to check annotation
ckohnert Apr 5, 2026
f752b29
Add optional rule failure code to annotations
ckohnert Apr 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions buf/plugin/check/v1/annotation.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,16 @@ message Annotation {
// this may reference the deleted FileDescriptor in against_file_descriptors, while file_location
// will not be present.
buf.plugin.descriptor.v1.FileLocation against_file_location = 4;
// A URL that provides more human-readable information about the rule in question.
//
// Optional.
string documentation_link = 5;
// An optional identifier that can help refine exactly how the rule was violated.
//
// Optional.
//
// Simple rules will probably not require this level of detail because it is obvious, but
// for more complex logic (such as checks involving external systems), it can be helpful to
// provide an identifier that narrows down why the rule failed.
string failure_code = 6;
}