Improvements to CMake + Introduction of CPack based packages #346

vijaiaeroastro · 2024-02-20T11:23:21Z

Base branch : develop (Right after the 2.3.0-alpha release)

This PR introduces significant enhancements to the CMake infrastructure of lib3mf, detailed as follows:

CMake Configuration: It adds a valid CMake configuration file, lib3mfConfig.cmake, enabling the inclusion of lib3mf as a standard CMake-based C++ library.
CPack Integration: The integration of CPack simplifies the structure of SDK package, which, though comprehensive, previously required additional steps like defining libraries and manually including header paths. With the use of the lib3mfConfig.cmake file, CPack facilitates the generation of CMake packages, including ready-to-install packages for Windows, Linux, and OSX, along with Debian and RPM packages for direct installation on the respective operating systems.
VCPKG Foundation: This update sets the groundwork for VCPKG integration, aiming to achieve a VCPKG deployment of lib3mf, which was a primary motivation behind the CMake improvements.

…anges in the root CMakeLists.txt to accomodate it + Introduction of CPack

…ng is an issue). Also symlinks seem to disappear. This will require a change in cmake config script since it requires exact .so file to be referenced instead of lib3mf.so (A problem to worry at a latter time)

…iant

…s automatically

…amic or CppDynamic variants

…s includes also for Windows and Mac OS

…hanged yet. It can be done after confirmation.

codecov · 2024-02-20T12:23:30Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.20%. Comparing base (8ceec9c) to head (5be552e).

Additional details and impacted files

@@                     Coverage Diff                     @@
##           feature/cmake-improvements     #346   +/-   ##
===========================================================
  Coverage                       69.20%   69.20%           
===========================================================
  Files                             271      271           
  Lines                           28691    28691           
===========================================================
  Hits                            19855    19855           
  Misses                           8836     8836

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

CMakeLists.txt

martinweismann · 2024-02-23T13:21:47Z

This all looks great!

Tested on windows the CppNew and CPPDynamic new.
CPPDynamic works out of the box.
The CppNew example's CMakeList does not yet take care of copying over the shared library.

We will need to clearly define what the role of the old sdk will be in the future, and how the examples are made available.

vijaiaeroastro · 2024-02-23T14:24:18Z

@martinweismann In CppNew, do you expect the library to be copied over to the same location as the target binary ?

martinweismann · 2024-02-23T14:30:47Z

I think so. That would make the example run out of the box.

vijaiaeroastro · 2024-02-23T14:35:43Z

I will make the necessary changes.

…n name is copy_lib3mf_libraries

vijaiaeroastro · 2024-03-27T16:12:02Z

@martinweismann The necessary CMake changes to fix VCPKG installation are included in the latest commits. For example, VCPKG requires the lib3mfConfig.cmake to be inside the share/lib3mf directory instead of the lib folder. This necessitates changes in the lib3mfConfig.cmake file, as the paths for the lib and bin directories are now different. These changes are dynamically handled in lib3mfConfig.cmake based on whether it is a VCPKG or non-VCPKG installation.

gangatp · 2024-04-08T10:58:06Z

.github/workflows/build.yml

@@ -1,6 +1,9 @@
 on: [push, pull_request]
+env:
+  LIB3MF_VERSION: "2.3.0"


Change the version to 2.3.1

gangatp · 2024-04-08T10:58:58Z

.github/workflows/build.yml

        uses: actions/upload-artifact@v2
        with:
          name: lib3mf.so
-          path: dist/lib3mf.so.2   
+          path: dist/lib3mf.so.2
+      - name: Extract File Name (CPacked Archive)


Is this Archive still necessary ?

gangatp

Hi Vijay,

I have few doubts in this PR regarding lib3mfconfig.cmake, does it help/break building lib3mf from source? Are the expamples in this PR, necessary?

vijaiaeroastro added 30 commits February 9, 2024 06:55

Include CMake config to make lib3mf into a valid CMake package and ch…

13dc8dd

…anges in the root CMakeLists.txt to accomodate it + Introduction of CPack

Update gitignore

b75f5ec

Comment out unnecessary workflows for easier debugging

397d572

.

931ad81

Disable memtest workflow too. Its expensive

7034f68

Include CPack generation for all 3 platforms

181d62b

Included CPack artifact archiving for all 3 platforms (First version)

13ae405

Fix erroneous paths in windows and osx. Linux works (but double zippi…

0e0fad5

…ng is an issue). Also symlinks seem to disappear. This will require a change in cmake config script since it requires exact .so file to be referenced instead of lib3mf.so (A problem to worry at a latter time)

Update dll path in CMake script

9465875

Include Debian and RPM build too (Testing)

e9aa144

Install RPM build

5b9477b

Make a variable called CDYNAMIC_SOURCE available for the CDynamic var…

a4dbd99

…iant

Make changes to make LIB3MF_LIBRARY_LOCATION available to source file…

a34e7ec

…s automatically

Check if artifact is single or double zipped

caf9207

Test SDK generation again

be09ed2

Testing sdk generation

372804d

Inclue cpacked artifacts to assemble SDK

ff7256b

Make necessary changes to ensure that linking does not happen in CDyn…

a461025

…amic or CppDynamic variants

First steps toward testing cpacked SDK's

3ded78b

Including Linux CppDynamic + Cpacked Cmake build

65f213d

Include DL also to CppDynamic linking

9625d60

Include Cpp variant example for Cpacked Linux package

55bab75

Cpp failure is due to a lower CMake version. First version of routine…

af3745b

…s includes also for Windows and Mac OS

Remove erroneous ls command from windows deployment

a955a12

First tests for debian package

2cc3470

Include examples for debian package too

0267604

Check the path once for debian

7b2a70f

Check if debian is being double zipped

660dfd2

.

f8f66f7

Check the type of debian archive

9d8eb4f

vijaiaeroastro added 6 commits February 20, 2024 09:49

.

62680b0

Debian tests should go through

1be809f

Include architecture to debian package

30f7430

Calling find_package twice is problematic. So we fix the issue

24a034b

Fix a minor mistake in Examples

e9a3209

Re-enable all blocks of the pipeline. Maintainer email has not been c…

dffabe7

…hanged yet. It can be done after confirmation.

martinweismann reviewed Feb 23, 2024

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

vijaiaeroastro added 4 commits February 26, 2024 16:32

Update maintainer email

c967681

A preliminary addition to config.cmake to copy libraries. The functio…

0b212ba

…n name is copy_lib3mf_libraries

Update CMake to remove global warning flags

0331062

Dynamically choose the library directory based on the type of tool chain

5be552e

gangatp reviewed Apr 8, 2024

View reviewed changes

.github/workflows/build.yml

@@ -1,6 +1,9 @@

on: [push, pull_request]

env:

LIB3MF_VERSION: "2.3.0"

Copy link

Collaborator

gangatp Apr 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change the version to 2.3.1

gangatp reviewed Apr 8, 2024

View reviewed changes

gangatp merged commit f96fc53 into 3MFConsortium:feature/cmake-improvements Apr 15, 2024
14 checks passed

This was referenced Jun 1, 2024

Building instructions for Linux distro packaging #8

Closed

Better CMake targets #265

Closed

Building a debian package for ib3mf v2 #128

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvements to CMake + Introduction of CPack based packages #346

Improvements to CMake + Introduction of CPack based packages #346

vijaiaeroastro commented Feb 20, 2024 •

edited

Loading

codecov bot commented Feb 20, 2024 •

edited

Loading

martinweismann commented Feb 23, 2024

vijaiaeroastro commented Feb 23, 2024

martinweismann commented Feb 23, 2024

vijaiaeroastro commented Feb 23, 2024

vijaiaeroastro commented Mar 27, 2024

gangatp Apr 8, 2024

gangatp Apr 8, 2024

gangatp left a comment

Improvements to CMake + Introduction of CPack based packages #346

Improvements to CMake + Introduction of CPack based packages #346

Conversation

vijaiaeroastro commented Feb 20, 2024 • edited Loading

codecov bot commented Feb 20, 2024 • edited Loading

Codecov Report

martinweismann commented Feb 23, 2024

vijaiaeroastro commented Feb 23, 2024

martinweismann commented Feb 23, 2024

vijaiaeroastro commented Feb 23, 2024

vijaiaeroastro commented Mar 27, 2024

gangatp Apr 8, 2024

Choose a reason for hiding this comment

gangatp Apr 8, 2024

Choose a reason for hiding this comment

gangatp left a comment

Choose a reason for hiding this comment

vijaiaeroastro commented Feb 20, 2024 •

edited

Loading

codecov bot commented Feb 20, 2024 •

edited

Loading