| commit | 6e17df8d65af87847b524504147f55651b2f4302 | [log] [tgz] |
|---|---|---|
| author | Antoine Musso <hashar@free.fr> | Thu Nov 02 18:26:11 2023 +0100 |
| committer | Ben Rohlfs <brohlfs@google.com> | Wed Nov 22 15:51:37 2023 +0000 |
| tree | c4abe522002caab4e6d8c066954b732e994e001d | |
| parent | 237f7e42a37df45de23f948212c331a99ad82684 [diff] |
Document `check-result-expanded` plugin endpoint In the Check UI, a CheckResult can optionally have a `message` which is raw unformatted text. A summary is displayed and when the result row is clicked, it is expanded and the full message is shown. I8dc5befc6a8fe4297709988b36ba489de5065b7b add `check-result-expanded` endpoint to the expanded component. That lets one add a Web Component with rich formatting. This was done for Chromium buildbucket plugin back in early 2021 and released in Gerrit 3.4.0, it was however left undocumented. Document the plugin end point. The code pass two parameters `result` and `run` which are set to be the `result`, I think it is a mistake in the original code which probably wanted to also pass the run, short of fixing the issue, document the `run` parameter is the same as the `result` one. I found out about the expanded results via the TypeScript API documentation. Remove the TBD comment about making CheckResults.message to support richer formatting and hint about using that endpoint which, as far as I am concerned, fulfill my need to beautify a check result. Test plan: bazel build Documentation xdg-open bazel-bin/Documentation/pg-plugin-endpoints.html Bug: Issue 308818104 Release-Notes: document `check-result-expanded` plugin endpoint Change-Id: Ifcc30aaa2c293bc515cac76052e3fc8b2d17471b
Gerrit is a code review and project management tool for Git based projects.
Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer.
Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer.
For information about how to install and use Gerrit, refer to the documentation.
Our canonical Git repository is located on googlesource.com. There is a mirror of the repository on Github.
Please report bugs on the issue tracker.
Gerrit is the work of hundreds of contributors. We appreciate your help!
Please read the contribution guidelines.
Note that we do not accept Pull Requests via the Github mirror.
The Developer Mailing list is repo-discuss on Google Groups.
Gerrit is provided under the Apache License 2.0.
Install Bazel and run the following:
git clone --recurse-submodules https://gerrit.googlesource.com/gerrit
cd gerrit && bazel build release
The instruction how to configure GerritForge/BinTray repositories is here
On Debian/Ubuntu run:
apt-get update & apt-get install gerrit=<version>-<release>
NOTE: release is a counter that starts with 1 and indicates the number of packages that have been released with the same version of the software.
On CentOS/RedHat run:
yum clean all && yum install gerrit-<version>[-<release>]
On Fedora run:
dnf clean all && dnf install gerrit-<version>[-<release>]
Docker images of Gerrit are available on DockerHub
To run a CentOS 8 based Gerrit image:
docker run -p 8080:8080 gerritcodereview/gerrit[:version]-centos8
To run a Ubuntu 20.04 based Gerrit image:
docker run -p 8080:8080 gerritcodereview/gerrit[:version]-ubuntu20
NOTE: release is optional. Last released package of the version is installed if the release number is omitted.