Add message documentation for GitCommitInformation (#2458)

Adds documentation to the `GitCommitInformation` message.
bufbuild · Sep 21, 2023 · 4f380fa · 4f380fa
1 parent ebec930
commit 4f380fa
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 34 deletions.
diff --git a/private/gen/proto/go/buf/alpha/registry/v1alpha1/git_metadata.pb.go b/private/gen/proto/go/buf/alpha/registry/v1alpha1/git_metadata.pb.go
diff --git a/proto/buf/alpha/registry/v1alpha1/git_metadata.proto b/proto/buf/alpha/registry/v1alpha1/git_metadata.proto
@@ -28,13 +28,16 @@ message GitIdentity {
   google.protobuf.Timestamp time = 3;
 }
 
+// GitCommitInformation is the information associated with a Git commit.
+// This always includes the hash.
+// The author and/or committer user identities are included when available.
 message GitCommitInformation {
   // Hash is the SHA1 hash of the git commit.
   string hash = 1;
   // Author is metadata associated with the author of the git commit.
   // This may not always be available, so it is not always populated.
-  optional GitIdentity author = 2;
+  GitIdentity author = 2;
   // Committer is the metadata associated with the committer of the git commit.
   // This may not always be available, so it is not always populated.
-  optional GitIdentity committer = 3;
+  GitIdentity committer = 3;
 }