Mercurial > sci

comparison doc/mainpage.c @ 33:1d0ddf9e6efd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents
children
comparison
equal deleted inserted replaced
32:081e1c258e64 33:1d0ddf9e6efd
1 /**
2 * \mainpage
3 * \brief Welcome to sci documentation
4 *
5 * This is sci, the simple continuous integration framework.
6 *
7 * The documentation available here targets users who want to hack on sci code,
8 * for user general documentation please read the appropriate manual pages.
9 *
10 * ## General overview
11 *
12 * The framework is split between three applications:
13 *
14 * - `scid`: the main daemon providing database access through HTTP (using
15 * CGI/FastCGI).
16 * - `scictl`: main user utility to manipulate the sci framework using the
17 * command line.
18 * - `sciworkerd`: daemon that fetches jobs, run them and send the result.
19 *
20 * ## Data models
21 *
22 * Every data model is converted back-and-forth using JSON all over the
23 * application to avoid converting over and over into native types. Also,
24 * because the framework uses [mustache][] and Javascript based themes it's
25 * easier to share the data model using this format.
26 *
27 * ### project
28 *
29 * - `name` (string): unique project identifir
30 * - `desc` (string): project description
31 * - `url` (string): project homepage or repository URL
32 * - `script` (string): code to execute
33 * - `date` (int): created timestamp
34 *
35 * ### worker
36 *
37 * - `name` (string): unique worker identifier
38 * - `desc` (string): worker description
39 *
40 * ### job
41 *
42 * - `id` (int): unique job id
43 * - `tag` (string): job tag (e.g. repository revision)
44 * - `project_name` (string): project name referenced
45 * - `date` (int): created timestamp
46 *
47 * ### jobresult
48 *
49 * - `id` (int): unique jobresult id
50 * - `job_id` (int): job id referenced
51 * - `worker_name` (string): worker name referenced
52 * - `console` (string): script console output
53 * - `exitcode` (int): script exit code (only if sigcode == 0)
54 * - `sigcode` (int): termination signal if interrupted (exitcode will be 0)
55 * - `date` (int): created timestamp (not the worker job timestamp)
56 *
57 * [mustache]: https://mustache.github.io/
58 */