aboutsummaryrefslogtreecommitdiff
path: root/doc/manual.cli
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2021-03-13 16:09:48 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2021-03-26 20:41:21 +0300
commit6ccee38f43493f8f6e87bab549e9ef952244f39a (patch)
tree3c75f102175fc6a566234e904a818dcd74029755 /doc/manual.cli
parentf7327a0b3cd6723cb289819bad1d664cfd5d6618 (diff)
Add support for interactive CI mode
Diffstat (limited to 'doc/manual.cli')
-rw-r--r--doc/manual.cli12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index 71a25a5..d0a1923 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -306,6 +306,15 @@ Check violations that are explicitly mentioned above are always reported with
the CI result manifest. Other errors (for example, internal server errors)
might be reported with unformatted text, including HTML.
+If the CI request contains the \c{interactive} parameter, then the CI service
+provides the execution environment login information for each test and stops
+them at the specified breakpoint.
+
+Pre-defined breakpoint ids are \c{error} and \c{warning}. The breakpoint id is
+included into the CI request manifest and the CI service must at least handle
+\c{error} but may recognize additional ids (build phase/command identifiers,
+etc).
+
If the CI request contains the \c{simulate} parameter, then the CI service
simulates the specified outcome of the CI process without actually performing
any externally visible actions (e.g., testing the package, publishing the
@@ -328,8 +337,9 @@ corresponding to the custom request parameters.
id: <request-id>
repository: <url>
[package]: <name>[/<version>]
-timestamp: <date-time>
+[interactive]: <breakpoint>
[simulate]: <outcome>
+timestamp: <date-time>
[client-ip]: <string>
[user-agent]: <string>
\