[CMAKE] bump cmake minimum required version to 3.14 #3349

dbarker · 2025-04-06T19:05:16Z

Fixes #3348

Changes

updates setup_cmake* scripts to verify the cmake version installed
bumps the cmake min version to 3.14 and fixes issues found when testing with that version
updates the cmake install test github workflow to test specific cmake versions including the min version

For significant contributions please make sure you have completed the following items:

CHANGELOG.md updated for non-trivial changes
Unit tests have been added
Changes in public API reviewed

…e min version

…including the min version. update the conan stable file to test older versions of benchmark and prometheus-cpp

netlify · 2025-04-06T19:05:31Z

✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.

Name	Link
🔨 Latest commit	`f3944bf`
🔍 Latest deploy log	https://app.netlify.com/sites/opentelemetry-cpp-api-docs/deploys/67f92d362bf4dd000879aa49

codecov · 2025-04-06T19:19:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.56%. Comparing base (4d52ab2) to head (f3944bf).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3349   +/-   ##
=======================================
  Coverage   89.56%   89.56%           
=======================================
  Files         210      210           
  Lines        6502     6502           
=======================================
  Hits         5823     5823           
  Misses        679      679

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ts with 3.14

…ake 3.15. Set the windows job to cmake 3.15

dbarker · 2025-04-07T00:25:52Z

CMakeLists.txt

@@ -1,7 +1,7 @@
 # Copyright The OpenTelemetry Authors
 # SPDX-License-Identifier: Apache-2.0

-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.14)


Rationale for bumping to 3.14

prometheus-cpp 1.0.0 requires cmake 3.14

googletest 1.14 requires cmake 3.13

Marc's comment on the last version bump implies 3.14 is okay for his project - [CMake] Upgrade cmake_minimum_required to 3.10 #3166 (comment)

Enables using the cmake FetchContent_MakeAvailable command which can help with Build googletest at buildtime, relying on CMake #3267

caveats

The otlp file exporter tests fail on windows unless built with cmake 3.15 see ExportToFileSystemRotateIndexTest and ExportToFileSystemRotateByTimeTest failures

The CMAKE_FIND_PACKAGE_PREFER_CONFIG option comes with 3.15 so changes in this file are required to properly find protobuf 3.22.0+ with cmake 3.14.

dbarker · 2025-04-07T00:38:48Z

.github/workflows/cmake_install.yml

    runs-on: windows-2019
    env:
+      CMAKE_VERSION: '3.15.0'


Windows tests only pass with cmake 3.15.0+ currently. This may be due to the addition of policy CMP0091 in cmake 3.15

Minor: Could we add this information as a comment in the file itself ?

Added a comment

dbarker · 2025-04-07T00:39:43Z

.github/workflows/cmake_install.yml

    runs-on: ubuntu-22.04
    env:
      INSTALL_TEST_DIR: '/home/runner/install_test'
+      CMAKE_VERSION: '3.14.0'


All tests pass in Ubuntu 22.04 with cmake 3.14

marcalff

LGTM, see minor comments.

marcalff · 2025-04-07T07:27:10Z

CMakeLists.txt

-  find_package(Protobuf)
-  # Protobuf 3.22 or upper require abseil-cpp, we can find it in
-  # opentelemetry-cpp-config.cmake
+  # Note: remove once cmake 3.14 is no longer supported including the


Suggested change

# Note: remove once cmake 3.14 is no longer supported including the

# Note: remove once cmake 3.14 is no longer supported. Including the

CMakeLists.txt

ci/setup_grpc.sh

install/test/cmake/component_tests/exporters_elasticsearch/CMakeLists.txt

CMakeLists.txt

…iables. Remove legacy PROTOBUF_FOUND.

psx95 · 2025-04-07T18:33:00Z

.github/workflows/cmake_install.yml

    runs-on: windows-2019
    env:
+      CMAKE_VERSION: '3.15.0'


Minor: Could we add this information as a comment in the file itself ?

psx95 · 2025-04-07T18:40:47Z

.github/workflows/cmake_install.yml

@@ -101,12 +103,17 @@ jobs:
        BUILD_SHARED_LIBS: 'OFF'
      run: ./ci/do_ci.sh cmake.install.test

-  ubuntu_2204_script_build_grpc_1_55_0:
-    name: Ubuntu 22.04 script grpc 1.55.0 cxx17 (static libs - shared libs)
+  ubuntu_2204_stable:


Q: CMAKE_VERSION specified for most jobs, except a this and macos_14_brew_packages. Any particular reason for that ?

The setup_cmake* scripts default to cmake 3.31.6 now. The scripts in the main ci.yml workflow also use the default.

I'm not apposed to setting CMAKE_VERSION in every job explicitly if others feel strongly.

The cmake version can be found in the ci logs at two places:

In the install step

Verifying installed versions... cmake version: 3.31.6 detected ctest version: 3.31.6 detected cpack version: 3.31.6 detected

Run test step

-- --------------------------------------------- -- versions -- --------------------------------------------- -- CMake: 3.31.6 -- GTest: 1.16.0 -- benchmark: 1.9.2 -- Abseil: 20240722 -- Protobuf: 29.3.0 -- gRPC: 1.71.0 -- CURL: 8.6.0 -- ZLIB: 1.2.12 -- nlohmann-json: 3.11.3 -- prometheus-cpp: 1.3.0 -- ---------------------------------------------

I don't have a strong opinion on whether the version should be explicitly specified either, but if the version is only being specified on certain jobs due to some technical constraints (like CI fails if we the default cmake version is used), I do think it is worthwhile to document why the version is being explicitly mentioned on those jobs.

This would be helpful in the future if and when we re-visit this file to upgrade or modify the jobs.

I'm not an expert on CMake, so I'll defer the final decision to you though 👍🏻

Thanks for the feedback. I've updated the cmake install test workflow to set the version explicitly for all jobs.

but if the version is only being specified on certain jobs due to some technical constraints (like CI fails if we the default cmake version is used), I do think it is worthwhile to document why the version is being explicitly mentioned on those jobs.

Great point. The only cases I'm aware of where ci fails based on the cmake version is windows with 3.14 (comment added to the CMake Install Test github workflow) and with cmake 4.0.0 (documented in #3334).

ci/setup_cmake.ps1

… error on protobuf version warning. Remove bzip2 as dependency for conan builds

…all test job. Add newline to the end of setup_cmake.ps1

…ommend cmake 3.15+ on windows.

…t failures with cmake 3.14

owent

LGTM now, thanks.

.github/workflows/cmake_install.yml

ThomsonTan · 2025-04-09T20:54:13Z

CMakeLists.txt

+  # https://github.com/grpc/grpc/pull/33361 for more details.
+  include(CMakeFindDependencyMacro)
+
+  # Protobuf 3.22+ and depends on abseil-cpp and must be found using the CONFIG


Suggested change

# Protobuf 3.22+ and depends on abseil-cpp and must be found using the CONFIG

# Protobuf 3.22+ depends on abseil-cpp and must be found using the CONFIG

And what does it mean for "must be found using the CONFIG search mode"? Seems module mode is also tried.

It is referencing the cmake find_package search modes. The module mode is also tried to ensure capability with protobuf packages that don't include the cmake config file (which enables the config search mode). For example the Ubuntu packages for libprotobuf must be found with the module search mode.

Updated the comment to be clear this is the cmake find_package search mode.

…um_to_3_14

.github/workflows/cmake_install.yml

CMakeLists.txt

ci/install_protobuf.sh

INSTALL.md

ThomsonTan · 2025-04-10T18:00:12Z

install/conan/conanfile_stable.txt

@@ -8,7 +8,7 @@ abseil/20230125.3
 protobuf/3.21.12
 grpc/1.54.3
 nlohmann_json/3.10.5
-prometheus-cpp/1.3.0
+prometheus-cpp/1.2.4


Why is version downgraded here?

Is prometheus 1.2.4 support expected?

Why is version downgraded here?

The conan based install tests have a "latest" and "stable" conanfile in install/conan. The conan file for "latest" includes prometheus-cpp/1.3.0. I downgraded prometheus-cpp version in the "stable" conan file to ensure the previous version was also tested.

install/conan/conanfile_stable.txt

dbarker added 3 commits April 6, 2025 12:30

update setup_cmake* scripts to verify the versions installed

08b9b3a

set cmake minimum version to 3.14. Fix issues found in tested with th…

e9cabbb

…e min version

update cmake install action workflow to test specific cmake versions …

0d7f90b

…including the min version. update the conan stable file to test older versions of benchmark and prometheus-cpp

dbarker added 3 commits April 6, 2025 15:25

fix format issue

8a85826

run the windows cmake min test with 3.16 due to failing otlp file tes…

80db032

…ts with 3.14

update changelog

6493ea3

dbarker changed the title ~~[BUILD] bump cmake minimum required version to 3.14~~ [CMAKE] bump cmake minimum required version to 3.14 Apr 6, 2025

add back explict policies including CMP0091 that was introduced in cm…

ee19538

…ake 3.15. Set the windows job to cmake 3.15

dbarker marked this pull request as ready for review April 7, 2025 00:13

dbarker requested a review from a team as a code owner April 7, 2025 00:13

dbarker commented Apr 7, 2025

View reviewed changes

marcalff approved these changes Apr 7, 2025

View reviewed changes

owent reviewed Apr 7, 2025

View reviewed changes

CMakeLists.txt Show resolved Hide resolved

owent reviewed Apr 7, 2025

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

owent reviewed Apr 7, 2025

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

owent reviewed Apr 7, 2025

View reviewed changes

ci/setup_grpc.sh Show resolved Hide resolved

owent requested changes Apr 7, 2025

View reviewed changes

install/test/cmake/component_tests/exporters_elasticsearch/CMakeLists.txt Outdated Show resolved Hide resolved

dbarker commented Apr 7, 2025

View reviewed changes

CMakeLists.txt Show resolved Hide resolved

Address review feedback. Always set the new curl and zlib version var…

7ca29e7

…iables. Remove legacy PROTOBUF_FOUND.

psx95 reviewed Apr 7, 2025

View reviewed changes

open-telemetry deleted a comment from TheMenisFactor Apr 7, 2025

dbarker added 5 commits April 7, 2025 14:13

add comment about cmake 3.15 as minimum for windows builds. Fix cmake…

9bb6fdb

… error on protobuf version warning. Remove bzip2 as dependency for conan builds

Merge branch 'main' into build_set_cmake_minimum_to_3_14

061d39c

set cmake version expliclity in the workflow file for each cmake inst…

e50e20e

…all test job. Add newline to the end of setup_cmake.ps1

use config search mode for gtest for install tests

b4da661

update install md file with note on the cmake minimum version and rec…

97a1e75

…ommend cmake 3.15+ on windows.

dbarker added 2 commits April 8, 2025 15:32

fix markdownlint error

7d29c69

Update install.md with explict message about the known windows ci tes…

9550ae2

…t failures with cmake 3.14

dbarker mentioned this pull request Apr 8, 2025

Build googletest at buildtime, relying on CMake #3267

Open

owent approved these changes Apr 9, 2025

View reviewed changes

lalitb reviewed Apr 9, 2025

View reviewed changes

.github/workflows/cmake_install.yml Show resolved Hide resolved

lalitb reviewed Apr 9, 2025

View reviewed changes

.github/workflows/cmake_install.yml Show resolved Hide resolved

lalitb reviewed Apr 9, 2025

View reviewed changes

.github/workflows/cmake_install.yml Show resolved Hide resolved

ThomsonTan reviewed Apr 9, 2025

View reviewed changes

dbarker added 2 commits April 9, 2025 16:00

comments from review feedback

c0ff987

Merge remote-tracking branch 'origin/main' into build_set_cmake_minim…

848428a

…um_to_3_14

lalitb reviewed Apr 10, 2025

View reviewed changes

.github/workflows/cmake_install.yml Show resolved Hide resolved

CMakeLists.txt Show resolved Hide resolved

lalitb reviewed Apr 10, 2025

View reviewed changes

ci/install_protobuf.sh Show resolved Hide resolved

lalitb approved these changes Apr 10, 2025

View reviewed changes

ThomsonTan reviewed Apr 10, 2025

View reviewed changes

INSTALL.md Outdated Show resolved Hide resolved

ThomsonTan reviewed Apr 10, 2025

View reviewed changes

install/conan/conanfile_stable.txt Show resolved Hide resolved

update install.md

f3944bf

lalitb merged commit 34375d7 into open-telemetry:main Apr 13, 2025
66 checks passed

dbarker deleted the build_set_cmake_minimum_to_3_14 branch April 19, 2025 00:42

BrewTestBot mentioned this pull request May 29, 2025

opentelemetry-cpp 1.21.0 Homebrew/homebrew-core#225080

Merged

	# Note: remove once cmake 3.14 is no longer supported including the
	# Note: remove once cmake 3.14 is no longer supported. Including the

	# Protobuf 3.22+ and depends on abseil-cpp and must be found using the CONFIG
	# Protobuf 3.22+ depends on abseil-cpp and must be found using the CONFIG

[CMAKE] bump cmake minimum required version to 3.14 #3349

[CMAKE] bump cmake minimum required version to 3.14 #3349

Conversation

dbarker commented Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

netlify bot commented Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.

Uh oh!

codecov bot commented Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dbarker Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbarker Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbarker Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcalff left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

owent left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbarker Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

dbarker commented Apr 6, 2025 •

edited

Loading

netlify bot commented Apr 6, 2025 •

edited

Loading

codecov bot commented Apr 6, 2025 •

edited

Loading

dbarker Apr 7, 2025 •

edited

Loading

dbarker Apr 7, 2025 •

edited

Loading

dbarker Apr 7, 2025 •

edited

Loading

dbarker Apr 11, 2025 •

edited

Loading