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 While the exact interpretation of the CI request depends on the spe‐
62 cific service, normally, the CI server will respond with a reference
63 that can be used to query the results. See Package CI (#ci) for details
64 on the CI request handling.
65
67 --yes|-y
68 Don't prompt for confirmation before submitting.
69 --server url
71 CI server to submit the request to.
72 --repository url
74 Remote repository URL for the project.
75 --override name:value
77 Package manifest value override. Repeat this option to override
78 multiple values.
79 --overrides-file file
81 Read manifest value overrides from the specified manifest frag‐
82 ment file. Repeat this option to specify multiple override
83 files.
84 --builds class-expr
86 Shortcut for --override builds:class-expr.
87 --build-email email
89 Shortcut for --override build-email:email.
90 --simulate outcome
92 Simulate the specified outcome of the CI process without actu‐
93 ally performing any externally visible actions (such as testing
94 the packages or publishing the result). The commonly used out‐
95 come value is success. For other recognized outcomes refer to
96 the CI service documentation.
97 --all|-a
99 Use all build configurations.
100 --config|-c dir
102 Specify the build configuration as a directory.
103 --directory|-d dir
105 Assume project/package is in the specified directory rather than
106 in the current working directory.
107 --config-name|-n name
109 Specify the build configuration as a name.
110 --config-id num
112 Specify the build configuration as an id.
113
115 The common options are summarized below with a more detailed descrip‐
116 tion available in bdep-common-options(1).
117 -v Print essential underlying commands being executed.
119 -V Print all underlying commands being executed.
121 --quiet|-q
123 Run quietly, only printing error messages.
124 --verbose level
126 Set the diagnostics verbosity to level between 0 and 6.
127 --jobs|-j num
129 Number of jobs to perform in parallel.
130 --no-progress
132 Suppress progress indicators for long-lasting operations, such
133 as network transfers, building, etc.
134 --bpkg path
136 The package manager program to be used for build configuration
137 management.
138 --bpkg-option opt
140 Additional option to be passed to the package manager program.
141 --build path
143 The build program to be used to build packages.
144 --build-option opt
146 Additional option to be passed to the build program.
147 --curl path
149 The curl program to be used for network operations.
150 --curl-option opt
152 Additional option to be passed to the curl program.
153 --pager path
155 The pager program to be used to show long text.
156 --pager-option opt
158 Additional option to be passed to the pager program.
159 --options-file file
161 Read additional options from file.
162 --default-options dir
164 The directory to load additional default options files from.
165 --no-default-options
167 Don't load default options files.
168
170 See bdep-default-options-files(1) for an overview of the default
171 options files. For the ci command the search start directory is the
172 project directory. The following options files are searched for in each
173 directory and, if found, loaded in the order listed:
174 bdep.options
176 bdep-ci.options
177 The following ci command options cannot be specified in the default
179 options files:
180 --directory|-d
182
184 Send bug reports to the users@build2.org mailing list.
185
187 Copyright (c) 2014-2019 Code Synthesis Ltd
188 Permission is granted to copy, distribute and/or modify this document
190 under the terms of the MIT License.
191bdep 0.12.0 November 2019 bdep-ci(1)