You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+22-1
Original file line number
Diff line number
Diff line change
@@ -272,6 +272,8 @@ There are also two additional parameters of the ``add_common_builds``:
272
272
-**shared_option_name**: If your conanfile.py have an option **shared**, the generated builds will contain automatically the "True/False" combination for that option.
273
273
Pass "False" to deactivate it or "lib_name:shared_option_name" to specify a custom option name, e.j: boost:my_shared``
274
274
-**dll_with_static_runtime**: Will add also the combination of runtime MT with shared libraries.
275
+
-**header_only**: If your conanfile.py have an option **header_only**, the generated builds will contain automatically the "True/False" combination for that option [#454](https://github.com/conan-io/conan-package-tools/issues/454).
276
+
-**build_all_options_values**: It includes all possible values for the listed options [#457](https://github.com/conan-io/conan-package-tools/issues/457).
275
277
276
278
```
277
279
from cpt.packager import ConanMultiPackager
@@ -365,7 +367,19 @@ In case you want to integrate CPT with other tools, for example you want to have
365
367
366
368
Alternatively you can use the `CPT_SUMMARY_FILE` environment variable to set the summary file path
367
369
370
+
## Using all values for custom options
371
+
Sometimes you want to include more options to your matrix, including all possible combinations, so that, you can use **build_all_options_values**:
Now let's say mypackage's recipe contains the follow options: *shared*, *fPIC*, *foo* and *bar*. Both *foo* and *bar* can accept **True** or **False**.
382
+
The method add_common_builds will generate a matrix including both *foo* and *bar* with all possible combinations.
369
383
370
384
## Using Docker
371
385
@@ -1099,6 +1113,7 @@ Using **CONAN_CLANG_VERSIONS** env variable in Travis ci or Appveyor:
1099
1113
rebuild all packages.
1100
1114
- "all": Build all requirements.
1101
1115
- **test_folder**: Custom test folder consumed by Conan create, e.j .conan/test_package
1116
+
- **lockfile**: Custom conan lockfile to be used, e.j. conan.lock. Default [None]
1102
1117
- **conanfile**: Custom conanfile consumed by Conan create. e.j. conanfile.py
1103
1118
- **config_url**: Conan config URL be installed before to build e.j https://github.com/bincrafters/conan-config.git
1104
1119
- **config_args**: Conan config arguments used when installing conan config
@@ -1139,12 +1154,15 @@ The current commit message can contain special messages:
1139
1154
1140
1155
## Complete ConanMultiPackager methods reference:
1141
1156
1142
-
- **add_common_builds(shared_option_name=None, pure_c=True, dll_with_static_runtime=False)**: Generate a set of package configurations and add them to the
1157
+
- **add_common_builds(shared_option_name=None, pure_c=True, dll_with_static_runtime=False, reference=None, header_only=True, build_all_options_values=None)**: Generate a set of package configurations and add them to the
1143
1158
list of packages that will be created.
1144
1159
1145
1160
- **shared_option_name**: If given, ConanMultiPackager will add different configurations for -o shared=True and -o shared=False.
1146
1161
- **pure_c**: ConanMultiPackager won't generate different builds for the **libstdc++** c++ standard library, because it is a pure C library.
1147
1162
- **dll_with_static_runtime**: generate also build for "MT" runtime when the library is shared.
1163
+
- **reference**: Custom package reference
1164
+
- **header_only**: Generate new builds following header-only options [#454](https://github.com/conan-io/conan-package-tools/issues/454)
1165
+
- **build_all_options_values**: Include all values for the listed options [#457](https://github.com/conan-io/conan-package-tools/issues/457)
1148
1166
1149
1167
- **login(remote_name)**: Performs a `conan user` command in the specified remote.
1150
1168
@@ -1205,6 +1223,7 @@ This is especially useful for CI integration.
1205
1223
- **CONAN_ARCHS**: Architectures to build for, comma separated, e.g. "x86,x86_64"
1206
1224
- **CONAN_OPTIONS**: Conan build options, comma separated, e.g. "foobar:with_bar=True,foobar:with_qux=False"
1207
1225
- **CONAN_SHARED_OPTION_NAME**: Set `shared_option_name` by environment variable, e.g. "mypackagename:shared"
1226
+
- **CONAN_BUILD_ALL_OPTIONS_VALUES**: Set `build_all_options_values` by environment variable, e.g. "mypackagename:foo,mypackagename:bar"
1208
1227
- **CONAN_BUILD_TYPES**: Build types to build for, comma separated, e.g. "Release,Debug"
1209
1228
- **CONAN_CPPSTDS**: List containing values for `compiler.cppstd`. Default None
1210
1229
- **CONAN_VISUAL_VERSIONS**: Visual versions, comma separated, e.g. "12,14"
@@ -1231,6 +1250,7 @@ This is especially useful for CI integration.
1231
1250
Set it with the bash executable path if it’s not in the PATH or you want to use a different one.
1232
1251
- **CONAN_PIP_USE_SUDO** Use "sudo" when invoking pip, by default it will use sudo when not using Windows and not running docker image "conanio/". "False" to deactivate.
1233
1252
- **CONAN_PIP_COMMAND** Run custom `pip` command when updating Conan. e.g. "/usr/bin/pip2"
1253
+
- **CONAN_DOCKER_PIP_COMMAND** Run custom `pip` command when updating Conan and CPT in Docker container. e.g. "/usr/bin/pip2"
1234
1254
- **CONAN_DOCKER_USE_SUDO** Use "sudo" when invoking docker, by default it will use sudo when not using Windows. "False" to deactivate.
1235
1255
- **CONAN_ALLOW_GCC_MINORS** Declare this variable if you want to allow gcc >=5 versions with the minor (5.1, 6.3 etc).
1236
1256
- **CONAN_EXCLUDE_VCVARS_PRECOMMAND** For Visual Studio builds, it exclude the vcvars call to set the environment.
@@ -1246,6 +1266,7 @@ This is especially useful for CI integration.
1246
1266
- **CONAN_BASE_PROFILE**: Apply options, settings, etc. to this profile instead of `default`.
1247
1267
- **CONAN_IGNORE_SKIP_CI**: Ignore `[skip ci]` in commit message.
1248
1268
- **CONAN_CONANFILE**: Custom conanfile consumed by Conan create. e.j. conanfile.py
1269
+
- **CONAN_LOCKFILE**: Custom conan lockfile to be used, e.j. conan.lock.
0 commit comments