diff options
author | Jacob Vosmaer <jacob@gitlab.com> | 2019-08-13 19:32:29 +0300 |
---|---|---|
committer | Paul Okstad <pokstad@gitlab.com> | 2019-08-13 19:32:29 +0300 |
commit | fee46e300ce5b473bb232fa5156fd1414e715807 (patch) | |
tree | 183ac69214903c1ba336a1e027287ecb5eb3664a /CONTRIBUTING.md | |
parent | d09c98f9ff0a1b7768b0f4c6bf88576e5bbbd80f (diff) |
Move gitaly-proto to gitaly/proto
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b6dbeb868..f258c28a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -175,54 +175,3 @@ It can also be used with profiling tools, for example [go-torch](https://github. ```shell go-torch --url http://localhost:9236 -p > flamegraph.svg ``` - -## Development and testing with a custom gitaly-proto - -During development you sometimes want to use a feature branch of -gitaly-proto instead of an officially released tag. This is how you -can do that. Every time you change gitaly-proto you need to perform -these steps. - -If you follow the process below, Gitaly's CI will be able to fetch -your custom protocol and use it to run the test suite. - -### 1. Change gitaly-proto - -- clone https://gitlab.com/gitlab-org/gitaly-proto.git -- create a new branch in gitaly-proto -- make changes to the `*.proto` files -- **run `make`** to generate the new protobuf wrapper code, otherwise your changes get ignored! -- `git add .` and commit -- push to your new branch in gitlab-org/gitaly-proto or to your own fork - -### 2. Make Gitaly use your custom gitaly-proto - -The following steps take place inside your Gitaly repo. - -- Fetch the generated Go code: - -```shell -# for forks: -_support/vendor-gitaly-proto --fork gitlab.com/my-user/gitaly-proto my-branch - -# for a gitlab-org branch: -_support/vendor-gitaly-proto my-branch - -# if the gitaly-proto version you want to use was already released: -_support/vendor-gitaly-proto v<tag-version> -``` - -- Include the new proto Go code in your next commit with `git add vendor` -- For gitaly-ruby, edit `ruby/Gemfile` so that it has: - -```ruby -gem 'gitaly-proto', git: 'https://gitlab.com/my-user/gitaly-proto.git', branch: 'my-branch' -``` - -- Update `Gemfile.lock` with - -```shell -cd ruby && bundle update gitaly-proto -``` - -- Include the changes in your next commit with `git add ruby/Gemfile ruby/Gemfile.lock` |