├── examples ├── example_package │ ├── src │ │ ├── Main.cpp │ │ └── MyLib.cpp │ ├── include │ │ └── MyLib.hpp │ └── CMakeLists.txt ├── example_project │ ├── src │ │ └── Main.cpp │ └── CMakeLists.txt └── example_external_package │ └── CMakeLists.txt ├── .gitignore ├── NOTICE ├── LICENSE ├── README.md └── CDeploy /examples/example_package/src/Main.cpp: -------------------------------------------------------------------------------- 1 | 2 | 3 | int main() 4 | { 5 | return 0; 6 | } 7 | -------------------------------------------------------------------------------- /examples/example_package/include/MyLib.hpp: -------------------------------------------------------------------------------- 1 | 2 | #pragma once 3 | 4 | int MyLibFunction(); 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /examples/example_package/build 2 | /examples/example_project/build 3 | /examples/example_external_package/build -------------------------------------------------------------------------------- /examples/example_package/src/MyLib.cpp: -------------------------------------------------------------------------------- 1 | 2 | #include 3 | 4 | int MyLibFunction() 5 | { 6 | return 1; 7 | } 8 | -------------------------------------------------------------------------------- /examples/example_project/src/Main.cpp: -------------------------------------------------------------------------------- 1 | 2 | #include 3 | #include 4 | 5 | int main() 6 | { 7 | MyLibFunction(); 8 | Console::printf("test\n"); 9 | return 0; 10 | } 11 | -------------------------------------------------------------------------------- /examples/example_project/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.1) 2 | 3 | project(example_project) 4 | 5 | include(../../CDeploy) 6 | 7 | deploy_package(example_package 0.1.0 "https://github.com/craflin/CDeploy/releases/download/test") 8 | deploy_package(libnstd 0.1.0 "https://github.com/craflin/CDeploy/releases/download/test") 9 | 10 | add_executable(example_binary 11 | src/Main.cpp 12 | ) 13 | 14 | target_link_libraries(example_binary 15 | example_package::mylib libnstd::libnstd 16 | ) 17 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | 2 | Copyright 2020-2023 Colin Graf 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | -------------------------------------------------------------------------------- /examples/example_package/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.1) 2 | cmake_policy(SET CMP0048 NEW) 3 | 4 | project(example_package VERSION 0.1.0) 5 | 6 | include(../../CDeploy) 7 | include(CPack) 8 | 9 | add_executable(mytool 10 | src/Main.cpp 11 | ) 12 | install(TARGETS mytool 13 | DESTINATION bin 14 | EXPORT ${PROJECT_NAME}Config 15 | ) 16 | 17 | add_library(mylib STATIC 18 | src/MyLib.cpp 19 | include/MyLib.hpp 20 | ) 21 | target_include_directories(mylib 22 | PUBLIC "$" 23 | PUBLIC "$" 24 | ) 25 | install(TARGETS mylib 26 | DESTINATION lib 27 | EXPORT ${PROJECT_NAME}Config 28 | ) 29 | install(DIRECTORY include 30 | DESTINATION . 31 | ) 32 | 33 | install_deploy_export() 34 | -------------------------------------------------------------------------------- /examples/example_external_package/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.1) 2 | cmake_policy(SET CMP0048 NEW) 3 | 4 | project(libnstd VERSION 0.1.0) 5 | 6 | set(CDEPLOY_NO_DEBUG_BUILD True) 7 | 8 | include(../../CDeploy) 9 | include(CPack) 10 | include(ExternalProject) 11 | 12 | if(MSVC) 13 | ExternalProject_Add(libnstd-debug 14 | GIT_REPOSITORY "https://github.com/craflin/libnstd.git" 15 | GIT_SHALLOW True 16 | SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/source" 17 | BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/build-debug" 18 | BUILD_COMMAND ${CMAKE_COMMAND} --build "${CMAKE_CURRENT_BINARY_DIR}/build-debug" --config Debug 19 | INSTALL_COMMAND "" 20 | ) 21 | install(FILES "${CMAKE_CURRENT_BINARY_DIR}/build-debug/src/Debug/libnstd.lib" 22 | DESTINATION lib 23 | RENAME libnstdd.lib 24 | ) 25 | deploy_export(libnstd LIBRARY STATIC 26 | CONFIGURATION Debug 27 | IMPORTED_LOCATION "lib/libnstdd.lib" 28 | INTERFACE_INCLUDE_DIRECTORIES "include" 29 | ) 30 | endif() 31 | 32 | ExternalProject_Add(libnstd-release 33 | GIT_REPOSITORY "https://github.com/craflin/libnstd.git" 34 | GIT_SHALLOW True 35 | SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/source" 36 | BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/build-release" 37 | BUILD_COMMAND ${CMAKE_COMMAND} --build "${CMAKE_CURRENT_BINARY_DIR}/build-release" --config Release 38 | INSTALL_COMMAND "" 39 | ) 40 | install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/source/include" DESTINATION .) 41 | 42 | if(MSVC) 43 | install(FILES "${CMAKE_CURRENT_BINARY_DIR}/build-release/src/Release/libnstd.lib" 44 | DESTINATION lib 45 | ) 46 | deploy_export(libnstd LIBRARY STATIC 47 | CONFIGURATION Release 48 | IMPORTED_LOCATION "lib/libnstd.lib" 49 | INTERFACE_INCLUDE_DIRECTORIES "include" 50 | ) 51 | else() 52 | install(FILES "${CMAKE_CURRENT_BINARY_DIR}/build-release/src/libnstd.a" 53 | DESTINATION lib 54 | ) 55 | deploy_export_dependency(Threads) 56 | deploy_export(libnstd LIBRARY STATIC 57 | IMPORTED_LOCATION "lib/libnstd.a" 58 | INTERFACE_INCLUDE_DIRECTORIES "include" 59 | PROPERTIES 60 | INTERFACE_LINK_LIBRARIES Threads::Threads 61 | ) 62 | endif() 63 | 64 | install_deploy_export() 65 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # CDeploy 4 | 5 | CDeploy is a simple CMake centric package manager and package format. It provides the CMake function `deploy_package` to download and unpack a ZIP file and uses [find_package](https://cmake.org/cmake/help/latest/command/find_package.html) in *config mode* to import external pre-build libraries, tools or other resources provided by the downloaded file. 6 | 7 | There is no global repository for packages, but if you are already familiar with modern CMake there is not much you need to learn to create your own CDeploy packages for your project. The idea is that each project maintains its own file server for dependencies unless they can be downloaded directly from another projects that provide CDeploy compatible packages. 8 | 9 | ## Example 10 | 11 | Add the [CDeploy](/CDeploy) file to your CMake project and create a `CMakeLists.txt` file like this: 12 | 13 | ```cmake 14 | cmake_minimum_required(VERSION 3.1) 15 | 16 | project(example_project) 17 | 18 | include(CDeploy) 19 | 20 | deploy_package(Qt5 5.11.2 "http://my.example-package-repository.com/packages") 21 | deploy_package(libxml2 2.7.8 "http://my.example-package-repository.com/packages") 22 | 23 | add_executable(example_binary 24 | Main.cpp 25 | ) 26 | 27 | target_link_libraries(example_binary 28 | Qt5::Core libxml2 29 | ) 30 | ``` 31 | 32 | ## Package Format 33 | 34 | ### Package Name 35 | 36 | `-[-][-][-].zip` 37 | 38 | * `` is the name in lower case of the imported product 39 | * `` is a generic version string with an optional package revision tag (e.g. 2.9.10-3) 40 | * `` is the target operating system or distribution name and version 41 | * `` is the target architecture (x86, x64, ppc64, etc.) 42 | * `` is a shorted name of the compiler with version number (gcc7, vs2015, etc.) 43 | 44 | Example: 45 | 46 | libxml2-2.7.8-3-ubuntu18.04-x64-gcc7.zip 47 | 48 | ### Package Contents 49 | 50 | Everything should be packaged in one directory with a unique name. This directory will be the argument for `PATHS` of `find_package`, so it should provide a CMake package configuration with version information. 51 | 52 | ## Creating a CDeploy Package 53 | 54 | CDeploy packages can be created in various ways: 55 | 56 | * directly with CMake using exported targets and CPack. 57 | * from an external project that is built with or without CMake. 58 | * from an external project and your own CMake build rules. 59 | 60 | Some projects may already produce a CDeploy compatible package that just need to be renamed to match the package naming conventions. 61 | 62 | ### Directly with CMake/CPack 63 | 64 | If you are building your project with CMake and have control over the build rules (`CMakeLists.txt` files) of the project, you can create a CDeploy package with CPack by using [install(TARGET ...)](https://cmake.org/cmake/help/latest/command/install.html) with the `EXPORT` option set to `${PROJECT_NAME}Config`. In Visual Studio builds, it will include a debug and release version of libraries. 65 | 66 | Example: 67 | 68 | ```cmake 69 | cmake_minimum_required(VERSION 3.1) 70 | cmake_policy(SET CMP0048 NEW) 71 | 72 | project(example_package VERSION 0.1.0) 73 | 74 | include(CDeploy) 75 | include(CPack) 76 | 77 | add_executable(mytool 78 | src/Main.cpp 79 | ) 80 | install(TARGETS mytool 81 | DESTINATION bin 82 | EXPORT ${PROJECT_NAME}Config 83 | ) 84 | 85 | add_library(mylib STATIC 86 | src/MyLib.cpp 87 | include/MyLib.hpp 88 | ) 89 | target_include_directories(mylib 90 | PUBLIC "$" 91 | PUBLIC "$" 92 | ) 93 | install(TARGETS mylib 94 | DESTINATION lib 95 | EXPORT ${PROJECT_NAME}Config 96 | ) 97 | install(DIRECTORY include 98 | DESTINATION . 99 | ) 100 | 101 | install_deploy_export() 102 | ``` 103 | 104 | The package is then generated using the `package` target in CMake. 105 | 106 | ``` 107 | cmake --build /your/project/dir --target package 108 | ``` 109 | 110 | With Visual Studio, you will have to compile the target `DEBUG_BUILD` first to ensure that a debug is available for packaging. Then build the `package` in `Release` configuration. 111 | 112 | ``` 113 | cmake --build /your/project/dir --target DEBUG_BUILD 114 | cmake --build /your/project/dir --target package --config Release 115 | ``` 116 | 117 | Alternatively, you can configure the project with `-DCDEPLOY_DEBUG_BUILD=ON` to skip the `DEBUG_BUILD` step. 118 | 119 | ### From an External Project 120 | 121 | An external project can be turned into a CDeploy package by compiling it with [ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject.html), exporting its targets with `deploy_export` and repackaging it with CPack. 122 | 123 | Example: 124 | 125 | ```cmake 126 | cmake_minimum_required(VERSION 3.1) 127 | cmake_policy(SET CMP0048 NEW) 128 | 129 | project(libnstd VERSION 0.1.0) 130 | 131 | set(CDEPLOY_NO_DEBUG_BUILD True) 132 | 133 | include(CDeploy) 134 | include(CPack) 135 | include(ExternalProject) 136 | 137 | if(MSVC) 138 | ExternalProject_Add(libnstd-debug 139 | GIT_REPOSITORY "https://github.com/craflin/libnstd.git" 140 | GIT_SHALLOW True 141 | SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/source" 142 | BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/build-debug" 143 | BUILD_COMMAND ${CMAKE_COMMAND} --build "${CMAKE_CURRENT_BINARY_DIR}/build-debug" --config Debug 144 | INSTALL_COMMAND "" 145 | ) 146 | install(FILES "${CMAKE_CURRENT_BINARY_DIR}/build-debug/src/Debug/libnstd.lib" 147 | DESTINATION lib 148 | RENAME libnstdd.lib 149 | ) 150 | deploy_export(libnstd LIBRARY STATIC 151 | CONFIGURATION Debug 152 | IMPORTED_LOCATION "lib/libnstdd.lib" 153 | INTERFACE_INCLUDE_DIRECTORIES "include" 154 | ) 155 | endif() 156 | 157 | ExternalProject_Add(libnstd-release 158 | GIT_REPOSITORY "https://github.com/craflin/libnstd.git" 159 | GIT_SHALLOW True 160 | SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/source" 161 | BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/build-release" 162 | BUILD_COMMAND ${CMAKE_COMMAND} --build "${CMAKE_CURRENT_BINARY_DIR}/build-release" --config Release 163 | INSTALL_COMMAND "" 164 | ) 165 | install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/source/include" DESTINATION .) 166 | 167 | if(MSVC) 168 | install(FILES "${CMAKE_CURRENT_BINARY_DIR}/build-release/src/Release/libnstd.lib" 169 | DESTINATION lib 170 | ) 171 | deploy_export(libnstd LIBRARY STATIC 172 | CONFIGURATION Release 173 | IMPORTED_LOCATION "lib/libnstd.lib" 174 | INTERFACE_INCLUDE_DIRECTORIES "include" 175 | ) 176 | else() 177 | install(FILES "${CMAKE_CURRENT_BINARY_DIR}/build-release/src/libnstd.a" 178 | DESTINATION lib 179 | ) 180 | deploy_export_dependency(Threads) 181 | deploy_export(libnstd LIBRARY STATIC 182 | IMPORTED_LOCATION "lib/libnstd.a" 183 | INTERFACE_INCLUDE_DIRECTORIES "include" 184 | PROPERTIES 185 | INTERFACE_LINK_LIBRARIES Threads::Threads 186 | ) 187 | endif() 188 | 189 | install_deploy_export() 190 | ``` 191 | 192 | If the external project is not built with CMake you will have to customize the `CONFIGURE_COMMAND` and `BUILD_COMMAND` of `ExternalProject_Add`. 193 | 194 | The package can be built with: 195 | 196 | ``` 197 | cmake --build /your/project/dir --target package 198 | ``` 199 | 200 | ### From an External Project with Your Own CMake Build Rules 201 | 202 | If an external project is not build with CMake, it might be easier to provide your own `CMakeLists.txt` file to compile the project with CMake instead of using its native build tool chain and repacking its artifacts. [ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject.html) can be used to import the sources of the external project. 203 | 204 | Example: 205 | 206 | ```cmake 207 | cmake_minimum_required(VERSION 3.1) 208 | cmake_policy(SET CMP0048 NEW) 209 | 210 | project(libfoo VERSION 0.1.0) 211 | 212 | include(CDeploy) 213 | include(CPack) 214 | include(ExternalProject) 215 | 216 | ExternalProject_Add(sources 217 | GIT_REPOSITORY "https://github.com/bar/foo.git" 218 | GIT_SHALLOW True 219 | GIT_TAG v${PROJECT_VERSION} 220 | SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/source" 221 | BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/build" 222 | CONFIGURE_COMMAND "" 223 | BUILD_COMMAND "" 224 | INSTALL_COMMAND "" 225 | ) 226 | 227 | set(SOURCES 228 | "${CMAKE_CURRENT_BINARY_DIR}/source/src/source_file1.cpp" 229 | "${CMAKE_CURRENT_BINARY_DIR}/source/src/source_file2.cpp" 230 | # ... 231 | ) 232 | set_source_files_properties(${SOURCES} 233 | PROPERTIES GENERATED True 234 | ) 235 | 236 | add_library(foo STATIC 237 | ${SOURCES} 238 | ) 239 | add_dependencies(foo 240 | sources 241 | ) 242 | 243 | target_include_directories(foo 244 | PUBLIC "$" 245 | PUBLIC "$" 246 | ) 247 | install(TARGETS foo 248 | DESTINATION lib 249 | EXPORT ${PROJECT_NAME}Config 250 | ) 251 | install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/source/include" 252 | DESTINATION . 253 | ) 254 | 255 | install_deploy_export() 256 | ``` 257 | 258 | The package is then generated using the `package` target in CMake. 259 | 260 | ``` 261 | cmake --build /your/project/dir --target package 262 | ``` 263 | 264 | With Visual Studio, you will have to compile the target `DEBUG_BUILD` first to ensure that a debug is available for packaging. Then build the `package` in `Release` configuration. 265 | 266 | ``` 267 | cmake --build /your/project/dir --target DEBUG_BUILD 268 | cmake --build /your/project/dir --target package --config Release 269 | ``` 270 | 271 | Alternatively, you can configure the project with `-DCDEPLOY_DEBUG_BUILD=ON` to skip the `DEBUG_BUILD` step. 272 | 273 | ## CDeploy Functions 274 | 275 | ### When Using CDeploy Packages 276 | 277 | #### `deploy_package` 278 | 279 | ``` 280 | deploy_package( [] 281 | [NO_OS] [NO_ARCH] [NO_COMPILER] [NO_CACHE] [NO_CONFIG_MAPPING] [COMPONENTS components...]) 282 | ``` 283 | 284 | The function downloads and unpacks a package file from the HTTP folder `` or an URL defined with `CDEPLOY_REPOSITORY` into the binary folder (`CMAKE_BINARY_DIR`) and uses CMake's [find_package](https://cmake.org/cmake/help/latest/command/find_package.html) in *config mode* to import the package. The optional `COMPONENTS` parameter is passed on to `find_package`. 285 | 286 | The package has to be named `-[-][-][-].zip` where ``, `` and `` can be omitted from the package file name using the options `NO_OS`, `NO_ARCH` and `NO_COMPILER`. ``, `` and `` are automatically detected in the local build environment. 287 | 288 | If `NO_CACHE` is set, a locally available package (in the exact version) or an already downloaded package will not be considered and the package will always be download from the repository. 289 | 290 | If `NO_CONFIG_MAPPING` is set, [MAP_IMPORTED_CONFIG_](https://cmake.org/cmake/help/latest/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.html) will not be set to map all project configurations other than *Debug* to the *Release* version of the libraries and tools provided by the deployed package. This does only affect Visual Studio builds. 291 | 292 | ### When Creating CDeploy Packages 293 | 294 | #### `deploy_export` 295 | 296 | ``` 297 | deploy_export( (INTERFACE | LIBRARY STATIC | LIBRARY SHARED | EXECUTABLE) 298 | [IMPORTED_LOCATION ] 299 | [CONFIGURATION (Release | Debug)] 300 | [IMPORTED_IMPLIB ] 301 | [INTERFACE_INCLUDE_DIRECTORIES ...] 302 | [INTERFACE_SOURCES ...] 303 | [INTERFACE_COMPILE_DEFINITIONS ...] 304 | [INTERFACE_COMPILE_FEATURES ...] 305 | [INTERFACE_COMPILE_OPTIONS