Asger Gitz-Johansen
05701d9d85
You should be able to tell your sci deployment which env vars should be passed to the pipelines with -e ENV1 -e ENV2 and so on
92 lines
2.1 KiB
Groff
92 lines
2.1 KiB
Groff
\" cli argument
|
|
.de AR
|
|
.B \\$1
|
|
.I \\$2
|
|
..
|
|
\" cli option
|
|
.de OP
|
|
[
|
|
.B \\$1
|
|
.I \\$2
|
|
\\$3
|
|
]
|
|
..
|
|
.de op
|
|
.TP
|
|
.BR \\$1 ", " \\$2 " " \fI\\$3
|
|
..
|
|
.TH sci 1 2024-08-17 "VERSION" "Simple CI manual"
|
|
|
|
.SH
|
|
NAME
|
|
sci - a simple continuous integration system
|
|
|
|
.SH
|
|
SYNOPSIS
|
|
.B sci
|
|
.AR -f /path/to/pipelines.conf
|
|
.br
|
|
.B sci
|
|
.AR -f /path/to/pipelines.conf
|
|
.AR -v 4
|
|
.AR -L /path/to/logs/
|
|
.br
|
|
.B sci
|
|
.AR -h
|
|
|
|
.SH
|
|
DESCRIPTION
|
|
This program provides a simple triggering system for your CI (Continuous Integration) server.
|
|
The operation of
|
|
.B sci
|
|
is configured through a
|
|
.I pipelines.conf
|
|
configuration file (see
|
|
.I sci(7)
|
|
for configuration language details)
|
|
and each pipeline will have an associated pipeline trigger file that can be
|
|
By default, pipeline triggers are placed in /tmp/sci but this can be overridden with the
|
|
.OP -x.
|
|
|
|
|
|
|
|
.SH EXAMPLES
|
|
A simple example configuration file could look something like the following:
|
|
|
|
"cool-horse" "example.com/cool" "on-cool" "/path/to/pipeline-scripts/cool.sh"
|
|
.br
|
|
"rad-horse" "example.com/rad" "on-rad" "/path/to/pipeline-scripts/rad.sh"
|
|
|
|
Each line represents a pipeline, and each argument is space-separated.
|
|
This example file creates two pipelines, one called "cool-horse" and another called "rad-horse".
|
|
Also note that arguments can, but are not required to be "-enclosed.
|
|
|
|
.SH OPTIONS
|
|
.op -f --input path
|
|
(required) add a TTA model path to parse.
|
|
|
|
.op -m --no-warn
|
|
disable all warnings.
|
|
|
|
.SH AUTHOR
|
|
Asger Gitz\-Johansen <asger.gitz@hotmail.com>.
|
|
|
|
.SH COPYRIGHT
|
|
Copyright (C) 2024 Asger Gitz-Johansen
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
.SH SEE ALSO
|
|
\" TODO: write sci(7)
|