Skip to content

Commit

Permalink
Add MetaComment proto
Browse files Browse the repository at this point in the history
  • Loading branch information
haya14busa committed Jun 18, 2024
1 parent 69ba613 commit b93717a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions proto/metacomment/metacomment.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
syntax = "proto3";
package reviewdog.rdf;

option go_package = "github.com/reviewdog/reviewdog/proto/metacomment";

// Represents a metadata of a diagnostic result.
// It's expected to be base64 encoded and included into reporter comments such
// as GitHub Pull Request Review comment.
//
// This metadata allow reviewdog to identify the same existing comment and
// avoid posting duplicated comments. It can also be used for resolving or
// deleting existing comments.
message MetaComment {
// An unique identity, or "fingerprint", of the diagnostic result.
string fingerprint = 1;

// Source (tool) name of the diagnostic result.
// It's important to have source name so that reviewdog can handle existing
// comments with the same source properly.
string source_name = 2;
}

0 comments on commit b93717a

Please sign in to comment.