Clarify that the `crd` endpoints returns a `CrdInfo`

While this is straight forward, explicitly stating it brings the docs
more in-line with Gerrit documentation, where each endpoint also
declares the returned entity also in text.

Change-Id: Iaf1ab426e1b37b2e41cf4d740539e9eb21ff3867
1 file changed
tree: 07011ce3c57dcaf19df4b9975ef73a34eeeea3fb
  1. gr-zuul/
  2. src/
  3. .eslintignore
  4. .eslintrc.json
  5. .gitignore
  6. BUILD
  7. LICENSE
  8. README.md
README.md

Gerrit Zuul Plugin

Openstack uses Zuul for project gating and one of the features of Zuul is cross repository dependencies (CRD). Zuul will detect CRDs in git commit messages to allow it to arrange patchsets (in order) before scheduling them for build and test.

The problems with having only a ‘depends-on’ reference:

  • It can become very difficult, downright confusing really, to determine the dependency relationships.
  • The use of CRD can produce dependency cycles which can be difficult to detect.

To help alleviate these issues this plugin adds the following:

  • A reverse lookup for the ‘depends-on’ reference.
  • A REST endpoint to allow other clients to retrieve CRD info.

Detailed information about this plugin can be found in the documentation.