1bdep-ci(1) General Commands Manual bdep-ci(1)
2
6 bdep-ci - submit project test request to CI server
7
9 bdep ci [options] [cfg-spec] [pkg-spec]
10 pkg-spec = (--directory|-d pkg-dir)... | prj-spec
12 prj-spec = --directory|-d prj-dir
13 cfg-spec = @cfg-name | --config|-c cfg-dir
14
16 The ci command submits the project packages test request to a CI
17 server.
18 If no project or package directory is specified, then the current work‐
20 ing directory is assumed. If no configuration is specified, then the
21 default configuration is used. If the specified directory is a project
22 directory, then all the packages initialized in the configuration are
23 submitted. See bdep-projects-configs(1) for details on specifying
24 projects and configurations.
25 A CI request consists of the specified packages and their versions as
27 well as the project's remote version control repository URL correspond‐
28 ing to the current (local) state of the project. The CI server should
29 be able to fetch these package versions from this repository as well as
30 any dependencies from this repository or its prerequisite/complement
31 repositories, according to each package's repositories.manifest.
32 If the CI server is not explicitly specified with the --server option,
34 the request is submitted to ci.cppget.org by default.
35 Unless the remote repository URL is specified with the --repository
37 option, it will be automatically derived from the version control's
38 "remote" URL. In case of git(1), it will be based on the remote.ori‐
39 gin.url configuration value unless overridden with remote.ori‐
40 gin.build2Url. The repository URL is then adjusted to corresponding to
41 the current (local) state of the project. In case of git(1), the cur‐
42 rent branch and commit id are added as the repository URL fragment (see
43 bpkg-repository-types(1) for details).
44 Some package manifest values can be overridden as part of the CI
46 request submission using the --override and --overrides-file options as
47 well as their --builds and --build-email shortcuts. This is primarily
48 useful for specifying alternative build configurations and/or build
49 notification emails. For example:
50 $ bdep ci --builds gcc
52 Note that manifest overrides override the entire value group that they
54 belong to. Currently, the following value groups can be overridden with
55 the build*-email group overridden by default as if by specifying an
56 empty build email.
57 build-email build-{warning,error}-email
59 builds build-{include,exclude}
60 Note also that the build constraints group values are overridden hier‐
62 archically so that the build-{include,exclude} overrides don't affect
63 the builds values.
64 While the exact interpretation of the CI request depends on the spe‐
66 cific service, normally, the CI server will respond with a reference
67 that can be used to query the results. See Package CI (#ci) for details
68 on the CI request handling.
69
71 --yes|-y
72 Don't prompt for confirmation before submitting.
73 --server url
75 CI server to submit the request to.
76 --repository url
78 Remote repository URL for the project.
79 --override name:value
81 Package manifest value override. Repeat this option to override
82 multiple values.
83 --overrides-file file
85 Read manifest value overrides from the specified manifest frag‐
86 ment file. Repeat this option to specify multiple override
87 files.
88 --builds class-expr
90 Shortcut for --override builds:class-expr.
91 --build-email email
93 Shortcut for --override build-email:email.
94 --simulate outcome
96 Simulate the specified outcome of the CI process without actu‐
97 ally performing any externally visible actions (such as testing
98 the packages or publishing the result). The commonly used out‐
99 come value is success. For other recognized outcomes refer to
100 the CI service documentation.
101 --all|-a
103 Use all build configurations.
104 --config|-c dir
106 Specify the build configuration as a directory.
107 --directory|-d dir
109 Assume project/package is in the specified directory rather than
110 in the current working directory.
111 --config-name|-n name
113 Specify the build configuration as a name.
114 --config-id num
116 Specify the build configuration as an id.
117
119 The common options are summarized below with a more detailed descrip‐
120 tion available in bdep-common-options(1).
121 -v Print essential underlying commands being executed.
123 -V Print all underlying commands being executed.
125 --quiet|-q
127 Run quietly, only printing error messages.
128 --verbose level
130 Set the diagnostics verbosity to level between 0 and 6.
131 --jobs|-j num
133 Number of jobs to perform in parallel.
134 --no-progress
136 Suppress progress indicators for long-lasting operations, such
137 as network transfers, building, etc.
138 --bpkg path
140 The package manager program to be used for build configuration
141 management.
142 --bpkg-option opt
144 Additional option to be passed to the package manager program.
145 --build path
147 The build program to be used to build packages.
148 --build-option opt
150 Additional option to be passed to the build program.
151 --curl path
153 The curl program to be used for network operations.
154 --curl-option opt
156 Additional option to be passed to the curl program.
157 --pager path
159 The pager program to be used to show long text.
160 --pager-option opt
162 Additional option to be passed to the pager program.
163 --options-file file
165 Read additional options from file.
166 --default-options dir
168 The directory to load additional default options files from.
169 --no-default-options
171 Don't load default options files.
172
174 See bdep-default-options-files(1) for an overview of the default
175 options files. For the ci command the search start directory is the
176 project directory. The following options files are searched for in each
177 directory and, if found, loaded in the order listed:
178 bdep.options
180 bdep-ci.options
181 The following ci command options cannot be specified in the default
183 options files:
184 --directory|-d
186
188 Send bug reports to the users@build2.org mailing list.
189
191 Copyright (c) 2014-2020 the build2 authors.
192 Permission is granted to copy, distribute and/or modify this document
194 under the terms of the MIT License.
195bdep 0.13.0 July 2020 bdep-ci(1)