diff options
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/cli.sh | 2 | ||||
| -rw-r--r-- | doc/manual.cli | 19 |
2 files changed, 20 insertions, 1 deletions
@@ -1,6 +1,6 @@ #! /usr/bin/env bash -version=0.16.0-a.0.z +version=0.17.0-a.0.z trap 'exit 1' ERR set -o errtrace # Trap in functions. diff --git a/doc/manual.cli b/doc/manual.cli index 6dab404..9b85ae6 100644 --- a/doc/manual.cli +++ b/doc/manual.cli @@ -341,12 +341,31 @@ repository: <url> timestamp: <date-time> [client-ip]: <string> [user-agent]: <string> +[service-id]: <string> +[service-type]: <string> +[service-data]: <string> +[service-action]: <action> \ The \c{package} value can be repeated multiple times. The \c{timestamp} value is in the ISO-8601 \c{<YYYY>-<MM>-<DD>T<hh>:<mm>:<ss>Z} form (always UTC). Note also that \c{client-ip} can be IPv4 or IPv6. +Note that some CI service implementations may serve as backends for +third-party services. The latter may initiate CI tasks, providing all the +required information via some custom protocol, and expect the CI service to +notify it about the progress. In this case the third-party service type as +well as optionally the third-party id and custom state data can be +communicated to the underlying CI handler program via the respective +\c{service-*} manifest values. Also note that normally a third-party service +has all the required information (repository URL, etc) available at the time +of the CI task initiation, in which case the \c{start} value is specified for +the \c{service-action} manifest value. If that's not the case, the CI task is +only created at the time of the initiation without calling the CI handler +program. In this case the CI handler is called later, when all the required +information is asynchronously gathered by the service. In this case the +\c{load} value is specified for the \c{service-action} manifest value. + \h#ci-overrides-manifest|CI Overrides Manifest| |