diff options
| author | Jacob Vosmaer <jacob@gitlab.com> | 2018-04-09 18:08:19 +0200 |
|---|---|---|
| committer | Jacob Vosmaer <jacob@gitlab.com> | 2018-04-09 18:08:19 +0200 |
| commit | de69f57aa6a02db6110b202781d4a024f4fa1c4c (patch) | |
| tree | b3fe822f10f7492900ce97020bae19bdec995120 | |
| parent | a04ec728fa748fd5a2d8e346486aff4bbf4f1bef (diff) | |
| download | gitlab-ce-docs-gitaly-for-new-git-features.tar.gz | |
Documentation for using custom versionsdocs-gitaly-for-new-git-features
| -rw-r--r-- | doc/development/gitaly.md | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/development/gitaly.md b/doc/development/gitaly.md index 34c34c3f40f..4f9ca1920a5 100644 --- a/doc/development/gitaly.md +++ b/doc/development/gitaly.md @@ -37,6 +37,10 @@ The process for adding new Gitaly features is: These steps often overlap. It is possible to use an unreleased version of Gitaly and gitaly-proto during testing and development. +- See the [Gitaly repo](https://gitlab.com/gitlab-org/gitaly/blob/master/CONTRIBUTING.md#development-and-testing-with-a-custom-gitaly-proto) for instructions on writing server side code with an unreleased protocol. +- See [below](#running-tests-with-a-locally-modified-version-of-gitaly) for instructions on running gitlab-ce tests with a modified version of Gitaly. +- In GDK run `gdk install` and restart `gdk run` (or `gdk run app`) to use a locally modified Gitaly version for development + ### Gitaly-ruby It is possible to implement and test RPC's in Gitaly using Ruby code, @@ -156,10 +160,14 @@ end ## Running tests with a locally modified version of Gitaly -Normally, gitlab-ce/ee tests use a local clone of Gitaly in `tmp/tests/gitaly` -pinned at the version specified in GITALY_SERVER_VERSION. If you want -to run tests locally against a modified version of Gitaly you can -replace `tmp/tests/gitaly` with a symlink. +Normally, gitlab-ce/ee tests use a local clone of Gitaly in +`tmp/tests/gitaly` pinned at the version specified in +`GITALY_SERVER_VERSION`. The `GITALY_SERVER_VERSION` file supports +`=my-branch` syntax to use a custom branch in gitlab-org/gitaly. If +you want to run tests locally against a modified version of Gitaly you +can replace `tmp/tests/gitaly` with a symlink. This is much faster +because the `=my-branch` syntax forces a Gitaly re-install each time +you run `rspec`. ```shell rm -rf tmp/tests/gitaly |