diff options
author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-05-02 12:42:47 +0300 |
---|---|---|
committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-05-06 12:59:52 +0300 |
commit | 14bd8a629594cfdaaaf8f4ba6197ba78df068626 (patch) | |
tree | 91722ee919fd8b5143cb231e9a353ccc7becdf12 | |
parent | fae2a928078822990118db7b10048db1e9787e26 (diff) |
proto: Enforce comment-linting for enum fields
Enforce that enum fields must have a comment and add a placeholder for
all instances where such a comment is missing.
-rw-r--r-- | proto/.protolint.yaml | 1 | ||||
-rw-r--r-- | proto/commit.proto | 29 | ||||
-rw-r--r-- | proto/diff.proto | 10 | ||||
-rw-r--r-- | proto/go/gitalypb/commit.pb.go | 40 | ||||
-rw-r--r-- | proto/go/gitalypb/diff.pb.go | 18 | ||||
-rw-r--r-- | proto/go/gitalypb/hook.pb.go | 10 | ||||
-rw-r--r-- | proto/go/gitalypb/lint.pb.go | 20 | ||||
-rw-r--r-- | proto/go/gitalypb/ref.pb.go | 44 | ||||
-rw-r--r-- | proto/go/gitalypb/repository.pb.go | 40 | ||||
-rw-r--r-- | proto/go/gitalypb/shared.pb.go | 30 | ||||
-rw-r--r-- | proto/go/gitalypb/transaction.pb.go | 10 | ||||
-rw-r--r-- | proto/go/gitalypb/wiki.pb.go | 12 | ||||
-rw-r--r-- | proto/hook.proto | 6 | ||||
-rw-r--r-- | proto/lint.proto | 12 | ||||
-rw-r--r-- | proto/ref.proto | 26 | ||||
-rw-r--r-- | proto/repository.proto | 22 | ||||
-rw-r--r-- | proto/shared.proto | 18 | ||||
-rw-r--r-- | proto/transaction.proto | 6 | ||||
-rw-r--r-- | proto/wiki.proto | 8 |
19 files changed, 317 insertions, 45 deletions
diff --git a/proto/.protolint.yaml b/proto/.protolint.yaml index 9d29ed88f..6105a0094 100644 --- a/proto/.protolint.yaml +++ b/proto/.protolint.yaml @@ -15,7 +15,6 @@ lint: # get protolint included in our workflow with minimal required changes. - FILE_HAS_COMMENT - FIELDS_HAVE_COMMENT - - ENUM_FIELDS_HAVE_COMMENT # Many of our fields and messages have prepositions in them, and # furthermore this rule doesn't feel all that sensible after all. We thus # disable it. diff --git a/proto/commit.proto b/proto/commit.proto index cb2b327c7..2924c36e5 100644 --- a/proto/commit.proto +++ b/proto/commit.proto @@ -338,9 +338,17 @@ message TreeEntryRequest { message TreeEntryResponse { // TODO: Replace this enum with ObjectType in shared.proto enum ObjectType { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COMMIT = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. BLOB = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TREE = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TAG = 3; } ObjectType type = 1; @@ -398,10 +406,17 @@ message CountDivergingCommitsResponse { message TreeEntry { // TODO: Replace this enum with ObjectType in shared.proto enum EntryType { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. BLOB = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TREE = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COMMIT = 3; } + // OID of the object this tree entry points to string oid = 1; // OID of the tree attached to commit_oid @@ -423,7 +438,11 @@ message GetTreeEntriesRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum SortBy { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. DEFAULT = 0; // Preserve order of git ls-tree + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TREES_FIRST = 1; // trees, blobs, submodules } @@ -514,8 +533,14 @@ message FindAllCommitsRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Order { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. NONE = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TOPO = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. DATE = 2; } @@ -538,7 +563,11 @@ message FindCommitsRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Order { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. NONE = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TOPO = 1; } diff --git a/proto/diff.proto b/proto/diff.proto index 46d51d0f7..26ec2f310 100644 --- a/proto/diff.proto +++ b/proto/diff.proto @@ -217,10 +217,20 @@ message ChangedPaths { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Status { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ADDED = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. MODIFIED = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. DELETED = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TYPE_CHANGE = 3; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COPIED = 4; } diff --git a/proto/go/gitalypb/commit.pb.go b/proto/go/gitalypb/commit.pb.go index c05db5902..f05fdcf39 100644 --- a/proto/go/gitalypb/commit.pb.go +++ b/proto/go/gitalypb/commit.pb.go @@ -82,10 +82,18 @@ func (ListCommitsRequest_Order) EnumDescriptor() ([]byte, []int) { type TreeEntryResponse_ObjectType int32 const ( + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TreeEntryResponse_COMMIT TreeEntryResponse_ObjectType = 0 - TreeEntryResponse_BLOB TreeEntryResponse_ObjectType = 1 - TreeEntryResponse_TREE TreeEntryResponse_ObjectType = 2 - TreeEntryResponse_TAG TreeEntryResponse_ObjectType = 3 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + TreeEntryResponse_BLOB TreeEntryResponse_ObjectType = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + TreeEntryResponse_TREE TreeEntryResponse_ObjectType = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + TreeEntryResponse_TAG TreeEntryResponse_ObjectType = 3 ) // Enum value maps for TreeEntryResponse_ObjectType. @@ -135,8 +143,14 @@ func (TreeEntryResponse_ObjectType) EnumDescriptor() ([]byte, []int) { type TreeEntry_EntryType int32 const ( - TreeEntry_BLOB TreeEntry_EntryType = 0 - TreeEntry_TREE TreeEntry_EntryType = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + TreeEntry_BLOB TreeEntry_EntryType = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + TreeEntry_TREE TreeEntry_EntryType = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TreeEntry_COMMIT TreeEntry_EntryType = 3 ) @@ -186,7 +200,11 @@ func (TreeEntry_EntryType) EnumDescriptor() ([]byte, []int) { type GetTreeEntriesRequest_SortBy int32 const ( - GetTreeEntriesRequest_DEFAULT GetTreeEntriesRequest_SortBy = 0 // Preserve order of git ls-tree + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetTreeEntriesRequest_DEFAULT GetTreeEntriesRequest_SortBy = 0 // Preserve order of git ls-tree + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. GetTreeEntriesRequest_TREES_FIRST GetTreeEntriesRequest_SortBy = 1 // trees, blobs, submodules ) @@ -234,8 +252,14 @@ func (GetTreeEntriesRequest_SortBy) EnumDescriptor() ([]byte, []int) { type FindAllCommitsRequest_Order int32 const ( + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. FindAllCommitsRequest_NONE FindAllCommitsRequest_Order = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. FindAllCommitsRequest_TOPO FindAllCommitsRequest_Order = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. FindAllCommitsRequest_DATE FindAllCommitsRequest_Order = 2 ) @@ -285,7 +309,11 @@ func (FindAllCommitsRequest_Order) EnumDescriptor() ([]byte, []int) { type FindCommitsRequest_Order int32 const ( + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. FindCommitsRequest_NONE FindCommitsRequest_Order = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. FindCommitsRequest_TOPO FindCommitsRequest_Order = 1 ) diff --git a/proto/go/gitalypb/diff.pb.go b/proto/go/gitalypb/diff.pb.go index 388a429d6..fb839dc6b 100644 --- a/proto/go/gitalypb/diff.pb.go +++ b/proto/go/gitalypb/diff.pb.go @@ -75,11 +75,21 @@ func (CommitDiffRequest_DiffMode) EnumDescriptor() ([]byte, []int) { type ChangedPaths_Status int32 const ( - ChangedPaths_ADDED ChangedPaths_Status = 0 - ChangedPaths_MODIFIED ChangedPaths_Status = 1 - ChangedPaths_DELETED ChangedPaths_Status = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ChangedPaths_ADDED ChangedPaths_Status = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ChangedPaths_MODIFIED ChangedPaths_Status = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ChangedPaths_DELETED ChangedPaths_Status = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ChangedPaths_TYPE_CHANGE ChangedPaths_Status = 3 - ChangedPaths_COPIED ChangedPaths_Status = 4 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ChangedPaths_COPIED ChangedPaths_Status = 4 ) // Enum value maps for ChangedPaths_Status. diff --git a/proto/go/gitalypb/hook.pb.go b/proto/go/gitalypb/hook.pb.go index f5dc729f0..3a98c753c 100644 --- a/proto/go/gitalypb/hook.pb.go +++ b/proto/go/gitalypb/hook.pb.go @@ -25,9 +25,15 @@ const ( type ReferenceTransactionHookRequest_State int32 const ( - ReferenceTransactionHookRequest_PREPARED ReferenceTransactionHookRequest_State = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ReferenceTransactionHookRequest_PREPARED ReferenceTransactionHookRequest_State = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ReferenceTransactionHookRequest_COMMITTED ReferenceTransactionHookRequest_State = 1 - ReferenceTransactionHookRequest_ABORTED ReferenceTransactionHookRequest_State = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ReferenceTransactionHookRequest_ABORTED ReferenceTransactionHookRequest_State = 2 ) // Enum value maps for ReferenceTransactionHookRequest_State. diff --git a/proto/go/gitalypb/lint.pb.go b/proto/go/gitalypb/lint.pb.go index ebc1b097d..39119356a 100644 --- a/proto/go/gitalypb/lint.pb.go +++ b/proto/go/gitalypb/lint.pb.go @@ -26,9 +26,17 @@ const ( type OperationMsg_Operation int32 const ( - OperationMsg_UNKNOWN OperationMsg_Operation = 0 - OperationMsg_MUTATOR OperationMsg_Operation = 1 - OperationMsg_ACCESSOR OperationMsg_Operation = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + OperationMsg_UNKNOWN OperationMsg_Operation = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + OperationMsg_MUTATOR OperationMsg_Operation = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + OperationMsg_ACCESSOR OperationMsg_Operation = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. OperationMsg_MAINTENANCE OperationMsg_Operation = 3 ) @@ -80,8 +88,12 @@ func (OperationMsg_Operation) EnumDescriptor() ([]byte, []int) { type OperationMsg_Scope int32 const ( + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. OperationMsg_REPOSITORY OperationMsg_Scope = 0 - OperationMsg_STORAGE OperationMsg_Scope = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + OperationMsg_STORAGE OperationMsg_Scope = 2 ) // Enum value maps for OperationMsg_Scope. diff --git a/proto/go/gitalypb/ref.pb.go b/proto/go/gitalypb/ref.pb.go index 4201bffe1..a10158fe3 100644 --- a/proto/go/gitalypb/ref.pb.go +++ b/proto/go/gitalypb/ref.pb.go @@ -26,8 +26,14 @@ const ( type FindLocalBranchesRequest_SortBy int32 const ( - FindLocalBranchesRequest_NAME FindLocalBranchesRequest_SortBy = 0 - FindLocalBranchesRequest_UPDATED_ASC FindLocalBranchesRequest_SortBy = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + FindLocalBranchesRequest_NAME FindLocalBranchesRequest_SortBy = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + FindLocalBranchesRequest_UPDATED_ASC FindLocalBranchesRequest_SortBy = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. FindLocalBranchesRequest_UPDATED_DESC FindLocalBranchesRequest_SortBy = 2 ) @@ -76,7 +82,11 @@ func (FindLocalBranchesRequest_SortBy) EnumDescriptor() ([]byte, []int) { type FindAllTagsRequest_SortBy_Key int32 const ( - FindAllTagsRequest_SortBy_REFNAME FindAllTagsRequest_SortBy_Key = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + FindAllTagsRequest_SortBy_REFNAME FindAllTagsRequest_SortBy_Key = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. FindAllTagsRequest_SortBy_CREATORDATE FindAllTagsRequest_SortBy_Key = 1 ) @@ -124,9 +134,17 @@ func (FindAllTagsRequest_SortBy_Key) EnumDescriptor() ([]byte, []int) { type CreateBranchResponse_Status int32 const ( - CreateBranchResponse_OK CreateBranchResponse_Status = 0 - CreateBranchResponse_ERR_EXISTS CreateBranchResponse_Status = 1 - CreateBranchResponse_ERR_INVALID CreateBranchResponse_Status = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + CreateBranchResponse_OK CreateBranchResponse_Status = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + CreateBranchResponse_ERR_EXISTS CreateBranchResponse_Status = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + CreateBranchResponse_ERR_INVALID CreateBranchResponse_Status = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. CreateBranchResponse_ERR_INVALID_START_POINT CreateBranchResponse_Status = 3 ) @@ -178,9 +196,17 @@ func (CreateBranchResponse_Status) EnumDescriptor() ([]byte, []int) { type ListRefsRequest_SortBy_Key int32 const ( - ListRefsRequest_SortBy_REFNAME ListRefsRequest_SortBy_Key = 0 - ListRefsRequest_SortBy_CREATORDATE ListRefsRequest_SortBy_Key = 1 - ListRefsRequest_SortBy_AUTHORDATE ListRefsRequest_SortBy_Key = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ListRefsRequest_SortBy_REFNAME ListRefsRequest_SortBy_Key = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ListRefsRequest_SortBy_CREATORDATE ListRefsRequest_SortBy_Key = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ListRefsRequest_SortBy_AUTHORDATE ListRefsRequest_SortBy_Key = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ListRefsRequest_SortBy_COMMITTERDATE ListRefsRequest_SortBy_Key = 3 ) diff --git a/proto/go/gitalypb/repository.pb.go b/proto/go/gitalypb/repository.pb.go index a6a89d572..3c8d8e434 100644 --- a/proto/go/gitalypb/repository.pb.go +++ b/proto/go/gitalypb/repository.pb.go @@ -73,9 +73,17 @@ func (WriteCommitGraphRequest_SplitStrategy) EnumDescriptor() ([]byte, []int) { type GetArchiveRequest_Format int32 const ( - GetArchiveRequest_ZIP GetArchiveRequest_Format = 0 - GetArchiveRequest_TAR GetArchiveRequest_Format = 1 - GetArchiveRequest_TAR_GZ GetArchiveRequest_Format = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetArchiveRequest_ZIP GetArchiveRequest_Format = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetArchiveRequest_TAR GetArchiveRequest_Format = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetArchiveRequest_TAR_GZ GetArchiveRequest_Format = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. GetArchiveRequest_TAR_BZ2 GetArchiveRequest_Format = 3 ) @@ -127,12 +135,26 @@ func (GetArchiveRequest_Format) EnumDescriptor() ([]byte, []int) { type GetRawChangesResponse_RawChange_Operation int32 const ( - GetRawChangesResponse_RawChange_UNKNOWN GetRawChangesResponse_RawChange_Operation = 0 - GetRawChangesResponse_RawChange_ADDED GetRawChangesResponse_RawChange_Operation = 1 - GetRawChangesResponse_RawChange_COPIED GetRawChangesResponse_RawChange_Operation = 2 - GetRawChangesResponse_RawChange_DELETED GetRawChangesResponse_RawChange_Operation = 3 - GetRawChangesResponse_RawChange_MODIFIED GetRawChangesResponse_RawChange_Operation = 4 - GetRawChangesResponse_RawChange_RENAMED GetRawChangesResponse_RawChange_Operation = 5 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetRawChangesResponse_RawChange_UNKNOWN GetRawChangesResponse_RawChange_Operation = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetRawChangesResponse_RawChange_ADDED GetRawChangesResponse_RawChange_Operation = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetRawChangesResponse_RawChange_COPIED GetRawChangesResponse_RawChange_Operation = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetRawChangesResponse_RawChange_DELETED GetRawChangesResponse_RawChange_Operation = 3 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetRawChangesResponse_RawChange_MODIFIED GetRawChangesResponse_RawChange_Operation = 4 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + GetRawChangesResponse_RawChange_RENAMED GetRawChangesResponse_RawChange_Operation = 5 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. GetRawChangesResponse_RawChange_TYPE_CHANGED GetRawChangesResponse_RawChange_Operation = 6 ) diff --git a/proto/go/gitalypb/shared.pb.go b/proto/go/gitalypb/shared.pb.go index bc6f87aa6..36aad578c 100644 --- a/proto/go/gitalypb/shared.pb.go +++ b/proto/go/gitalypb/shared.pb.go @@ -26,11 +26,21 @@ const ( type ObjectType int32 const ( + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ObjectType_UNKNOWN ObjectType = 0 - ObjectType_COMMIT ObjectType = 1 - ObjectType_BLOB ObjectType = 2 - ObjectType_TREE ObjectType = 3 - ObjectType_TAG ObjectType = 4 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ObjectType_COMMIT ObjectType = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ObjectType_BLOB ObjectType = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ObjectType_TREE ObjectType = 3 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + ObjectType_TAG ObjectType = 4 ) // Enum value maps for ObjectType. @@ -83,10 +93,18 @@ func (ObjectType) EnumDescriptor() ([]byte, []int) { type SignatureType int32 const ( + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. SignatureType_NONE SignatureType = 0 - SignatureType_PGP SignatureType = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + SignatureType_PGP SignatureType = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. SignatureType_X509 SignatureType = 2 - SignatureType_SSH SignatureType = 3 // maybe add X509+TSA or other combinations at a later step + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + SignatureType_SSH SignatureType = 3 // maybe add X509+TSA or other combinations at a later step ) // Enum value maps for SignatureType. diff --git a/proto/go/gitalypb/transaction.pb.go b/proto/go/gitalypb/transaction.pb.go index e80da346c..3927b7d6f 100644 --- a/proto/go/gitalypb/transaction.pb.go +++ b/proto/go/gitalypb/transaction.pb.go @@ -84,9 +84,15 @@ func (VoteTransactionRequest_Phase) EnumDescriptor() ([]byte, []int) { type VoteTransactionResponse_TransactionState int32 const ( + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. VoteTransactionResponse_COMMIT VoteTransactionResponse_TransactionState = 0 - VoteTransactionResponse_ABORT VoteTransactionResponse_TransactionState = 1 - VoteTransactionResponse_STOP VoteTransactionResponse_TransactionState = 2 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + VoteTransactionResponse_ABORT VoteTransactionResponse_TransactionState = 1 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + VoteTransactionResponse_STOP VoteTransactionResponse_TransactionState = 2 ) // Enum value maps for VoteTransactionResponse_TransactionState. diff --git a/proto/go/gitalypb/wiki.pb.go b/proto/go/gitalypb/wiki.pb.go index 6b2508849..6ca1b4bc0 100644 --- a/proto/go/gitalypb/wiki.pb.go +++ b/proto/go/gitalypb/wiki.pb.go @@ -25,7 +25,11 @@ const ( type WikiGetAllPagesRequest_SortBy int32 const ( - WikiGetAllPagesRequest_TITLE WikiGetAllPagesRequest_SortBy = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + WikiGetAllPagesRequest_TITLE WikiGetAllPagesRequest_SortBy = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. WikiGetAllPagesRequest_CREATED_AT WikiGetAllPagesRequest_SortBy = 1 ) @@ -73,7 +77,11 @@ func (WikiGetAllPagesRequest_SortBy) EnumDescriptor() ([]byte, []int) { type WikiListPagesRequest_SortBy int32 const ( - WikiListPagesRequest_TITLE WikiListPagesRequest_SortBy = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. + WikiListPagesRequest_TITLE WikiListPagesRequest_SortBy = 0 + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. WikiListPagesRequest_CREATED_AT WikiListPagesRequest_SortBy = 1 ) diff --git a/proto/hook.proto b/proto/hook.proto index 8a3eaba39..0ee1f0a14 100644 --- a/proto/hook.proto +++ b/proto/hook.proto @@ -112,8 +112,14 @@ message ReferenceTransactionHookRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum State { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. PREPARED = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COMMITTED = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ABORTED = 2; } diff --git a/proto/lint.proto b/proto/lint.proto index 67c0c71ef..469822d1a 100644 --- a/proto/lint.proto +++ b/proto/lint.proto @@ -12,16 +12,28 @@ message OperationMsg { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Operation { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. UNKNOWN = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. MUTATOR = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ACCESSOR = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. MAINTENANCE = 3; } // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Scope { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. REPOSITORY = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. STORAGE = 2; reserved 1; diff --git a/proto/ref.proto b/proto/ref.proto index 8a2f145a8..d5c0742fd 100644 --- a/proto/ref.proto +++ b/proto/ref.proto @@ -205,8 +205,14 @@ message FindLocalBranchesRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum SortBy { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. NAME = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. UPDATED_ASC = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. UPDATED_DESC = 2; } @@ -289,7 +295,11 @@ message FindAllTagsRequest { message SortBy { // Key is a key used for sorting. enum Key { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. REFNAME = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. CREATORDATE = 1; } @@ -340,9 +350,17 @@ message CreateBranchResponse { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Status { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. OK = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ERR_EXISTS = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ERR_INVALID = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ERR_INVALID_START_POINT = 3; } @@ -526,9 +544,17 @@ message ListRefsRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Key { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. REFNAME = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. CREATORDATE = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. AUTHORDATE = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COMMITTERDATE = 3; } diff --git a/proto/repository.proto b/proto/repository.proto index 1c2e2c36b..b08f9e16b 100644 --- a/proto/repository.proto +++ b/proto/repository.proto @@ -554,9 +554,17 @@ message GetArchiveRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Format { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ZIP = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TAR = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TAR_GZ = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TAR_BZ2 = 3; } @@ -866,12 +874,26 @@ message GetRawChangesResponse { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum Operation { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. UNKNOWN = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ADDED = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COPIED = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. DELETED = 3; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. MODIFIED = 4; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. RENAMED = 5; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TYPE_CHANGED = 6; } diff --git a/proto/shared.proto b/proto/shared.proto index 8c6d0b51d..b07620f37 100644 --- a/proto/shared.proto +++ b/proto/shared.proto @@ -10,19 +10,37 @@ option go_package = "gitlab.com/gitlab-org/gitaly/v14/proto/go/gitalypb"; // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum ObjectType { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. UNKNOWN = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COMMIT = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. BLOB = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TREE = 3; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TAG = 4; } // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum SignatureType { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. NONE = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. PGP = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. X509 = 2; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. SSH = 3; // maybe add X509+TSA or other combinations at a later step } diff --git a/proto/transaction.proto b/proto/transaction.proto index e7059437d..f6f7a12c5 100644 --- a/proto/transaction.proto +++ b/proto/transaction.proto @@ -78,8 +78,14 @@ message VoteTransactionResponse { // The outcome of the given transaction telling the client whether the // transaction should be committed or rolled back. enum TransactionState { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. COMMIT = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. ABORT = 1; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. STOP = 2; } diff --git a/proto/wiki.proto b/proto/wiki.proto index 7ca2f5111..1d80249c0 100644 --- a/proto/wiki.proto +++ b/proto/wiki.proto @@ -146,7 +146,11 @@ message WikiGetAllPagesRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum SortBy { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TITLE = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. CREATED_AT = 1; } @@ -170,7 +174,11 @@ message WikiListPagesRequest { // protolint:disable:this ENUMS_HAVE_COMMENT // This comment is left unintentionally blank. enum SortBy { + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. TITLE = 0; + // protolint:disable:this ENUM_FIELDS_HAVE_COMMENT + // This comment is left unintentionally blank. CREATED_AT = 1; } |