tree c4abe522002caab4e6d8c066954b732e994e001d
parent 237f7e42a37df45de23f948212c331a99ad82684
author Antoine Musso <hashar@free.fr> 1698945971 +0100
committer Ben Rohlfs <brohlfs@google.com> 1700668297 +0000

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