Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitaly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWill Chandler <wchandler@gitlab.com>2022-05-11 22:16:08 +0300
committerWill Chandler <wchandler@gitlab.com>2022-05-12 04:51:19 +0300
commit8e3ad7f93edb20ad5ecb9024399c8044f7f19bbe (patch)
tree94a6ca646e9b59bc5a47bd0994147797925855b9
parentd4df39f4cfa395cd2a8f72a52e08495029a2d1d4 (diff)
doc: Update Protobuf verification docswc-proto-contrib
The 'Contributing' section of the Protobuf doc still references the old `gitaly-proto` project and incorrectly suggests that the source files generated by `protoc` may vary with Go version. This removes the outdated and incorrect information and adds a new section with details on the `make` targets for linting and validating protos.
-rw-r--r--doc/protobuf.md19
1 files changed, 7 insertions, 12 deletions
diff --git a/doc/protobuf.md b/doc/protobuf.md
index f7e188323..4ed62296f 100644
--- a/doc/protobuf.md
+++ b/doc/protobuf.md
@@ -358,18 +358,6 @@ declared. This is done via the `go_package` option:
This allows other protobuf files to locate and import the Go generated stubs.
-## Contributing
-
-The CI at https://gitlab.com/gitlab-org/gitaly-proto regenerates the
-client libraries to guard against the mistake of updating the .proto
-files but not the client libraries. This check uses `git diff` to look
-for changes. Some of the code in the Go client libraries is sensitive
-to implementation details of the Go standard library (specifically,
-the output of gzip). **Use the same Go version as .gitlab-ci.yml (Go
-1.13)** when generating new client libraries for a merge request.
-
-[DCO + License](CONTRIBUTING.md)
-
## Workflows
### Generating Protobuf sources
@@ -382,6 +370,13 @@ libraries before committing your change.
make proto
```
+### Verifying Protobuf definitions
+
+Gitaly provides a `make lint-proto` target to verify that Protobuf definitions
+conform to our coding style. Furthermore, Gitaly's CI verifies that sources
+generated from the definitions are up-to-date by regenerating sources and then
+running `no-proto-changes`.
+
### Deprecating an RPC call
See [PROCESS.md](PROCESS.md#rpc-deprecation-process).