Merge branch 'release/3.9.0'

* gh/release/3.9.0: Version 3.9.0 Add downstream ci (#72) Fix ecbuild_disable_unused_feature Add workflow to check release version is correct (#54) Add ecbuild_override_compiler_flags macro Add utility to initialise overrideable compiler flags Add utility to purge compiler flags for a given language Add tests according to Github issue #65 Enable distinction between enabled/disabled features Update ci action to v2 (#68) Stricter match condition for _fail strings (#64) CPP out LOC calls for NAG.
ecmwf · Nov 18, 2024 · 8401ff7 · 8401ff7
2 parents a07c0a5 + 617eb67
commit 8401ff7
Show file tree

Hide file tree

Showing 23 changed files with 485 additions and 72 deletions.
diff --git a/.github/ci-config.yml b/.github/ci-config.yml
@@ -0,0 +1,2 @@
+dependency_branch: develop
+parallelism_factor: 8
diff --git a/.github/ci-hpc-config.yml b/.github/ci-hpc-config.yml
@@ -0,0 +1,5 @@
+build:
+  modules:
+    - ninja
+  parallel: 64
+
diff --git a/.github/workflows/check-release-version.yml b/.github/workflows/check-release-version.yml
@@ -0,0 +1,11 @@
+name: Check VERSION file
+
+on:
+  push:
+    branches:
+      - "release/**"
+      - "hotfix/**"
+
+jobs:
+  check_version:
+    uses: ecmwf-actions/reusable-workflows/.github/workflows/check-release-version.yml@v2
diff --git a/.github/workflows/ci-single.yml b/.github/workflows/ci-single.yml
@@ -0,0 +1,28 @@
+name: ci-single
+
+# Controls when the workflow will run
+on:
+
+  # Trigger the workflow on all pushes, except on tag creation
+  push:
+    branches:
+    - '**'
+    tags-ignore:
+    - '**'
+
+  # Trigger the workflow on all pull requests
+  pull_request: ~
+
+  # Allow workflow to be dispatched on demand
+  workflow_dispatch: ~
+
+jobs:
+
+  # Calls a reusable CI workflow to build & test the current repository.
+  #   We skip jobs that will result in duplicate artifacts, since the code does not depend on the compiler.
+  ci:
+    name: ci
+    uses: ecmwf-actions/reusable-workflows/.github/workflows/ci.yml@v2
+    with:
+      skip_matrix_jobs: |
+        clang@rocky-8.6
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,30 +1,97 @@
 name: ci
 
-# Controls when the workflow will run
 on:
-
-  # Trigger the workflow on all pushes, except on tag creation
+  # Trigger the workflow on push to master or develop, except tag creation
   push:
     branches:
-    - '**'
+      - "master"
+      - "develop"
     tags-ignore:
-    - '**'
+      - "**"
+    paths-ignore:
+      - "docs/**"
+      - "bamboo/**"
+      - "README.rst"
 
-  # Trigger the workflow on all pull requests
+  # Trigger the workflow on pull request
   pull_request: ~
 
-  # Allow workflow to be dispatched on demand
+  # Trigger the workflow manually
   workflow_dispatch: ~
 
+  # Trigger after public PR approved for CI
+  pull_request_target:
+    types: [labeled]
+
+
 jobs:
+  # Run CI including downstream packages on self-hosted runners
+  downstream-ci:
+    name: downstream-ci
+    if: ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
+    uses: ecmwf-actions/downstream-ci/.github/workflows/downstream-ci.yml@main
+    with:
+      ecbuild: ecmwf/ecbuild@${{ github.event.pull_request.head.sha || github.sha }}
+      codecov_upload: false
+    secrets: inherit
 
-  # Calls a reusable CI workflow to build & test the current repository.
-  #   We skip jobs that will result in duplicate artifacts, since the code does not depend on the compiler.
-  ci:
-    name: ci
-    uses: ecmwf-actions/reusable-workflows/.github/workflows/ci.yml@v1
+  # Run CI of private downstream packages on self-hosted runners
+  private-downstream-ci:
+    name: private-downstream-ci
+    needs: [downstream-ci]
+    if: (success() || failure()) && ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Dispatch private downstream CI
+        uses: ecmwf-actions/dispatch-private-downstream-ci@v1
+        with:
+          token: ${{ secrets.GH_REPO_READ_TOKEN }}
+          owner: ecmwf-actions
+          repository: private-downstream-ci
+          event_type: downstream-ci
+          payload: '{"ecbuild": "ecmwf/ecbuild@${{ github.event.pull_request.head.sha || github.sha }}"}'
+
+  # Build downstream packages on HPC
+  downstream-ci-hpc:
+    name: downstream-ci-hpc
+    if: ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
+    uses: ecmwf-actions/downstream-ci/.github/workflows/downstream-ci-hpc.yml@main
     with:
-      skip_matrix_jobs: |
-        clang-12@ubuntu-20.04
-        clang-9@ubuntu-18.04
-        clang-12@macos-10.15
+      ecbuild: ecmwf/ecbuild@${{ github.event.pull_request.head.sha || github.sha }}
+    secrets: inherit
+
+  # Run CI of private downstream packages on HPC
+  private-downstream-ci-hpc:
+    name: private-downstream-ci-hpc
+    needs: [downstream-ci-hpc]
+    if: (success() || failure()) && ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Dispatch private downstream CI
+        uses: ecmwf-actions/dispatch-private-downstream-ci@v1
+        with:
+          token: ${{ secrets.GH_REPO_READ_TOKEN }}
+          owner: ecmwf-actions
+          repository: private-downstream-ci
+          event_type: downstream-ci-hpc
+          payload: '{"ecbuild": "ecmwf/ecbuild@${{ github.event.pull_request.head.sha || github.sha }}","skip_matrix_jobs": "nvidia-22.11"}'
+
+# DISABLED FOR NOW UNTIL REPO IS SET UP FOR THIS
+#  notify:
+#    runs-on: ubuntu-latest
+#    needs:
+#      - downstream-ci
+#      - private-downstream-ci
+#      - downstream-ci-hpc
+#      - private-downstream-ci-hpc
+#    if: ${{ always() && !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
+#    steps:
+#      - name: Trigger Teams notification
+#        uses: ecmwf-actions/notify-teams@v1
+#        with:
+#          incoming_webhook: ${{ secrets.MS_TEAMS_INCOMING_WEBHOOK }}
+#          needs_context: ${{ toJSON(needs) }}
diff --git a/cmake/VERSION b/cmake/VERSION
@@ -1 +1 @@
-3.8.5
+3.9.0
diff --git a/cmake/ecbuild_add_option.cmake b/cmake/ecbuild_add_option.cmake
@@ -109,7 +109,7 @@ macro( ecbuild_add_option )
     set( _p_DEFAULT ON )
   else()
     if( NOT _p_DEFAULT MATCHES "[Oo][Nn]" AND NOT _p_DEFAULT MATCHES "[Oo][Ff][Ff]" )
-      ecbuild_critical("In macro ecbuild_add_option(), DEFAULT is either ON or OFF: \"${_p_DEFAULT}\"")
+      ecbuild_critical("In macro ecbuild_add_option(), DEFAULT must be either ON or OFF, but found: \"${_p_DEFAULT}\"")
     endif()
   endif()
   ecbuild_debug("ecbuild_add_option(${_p_FEATURE}): defaults to ${_p_DEFAULT}")
@@ -153,12 +153,6 @@ macro( ecbuild_add_option )
   # define the option -- for cmake GUI
 
   option( ENABLE_${_p_FEATURE} "${_p_DESCRIPTION}" ${_p_DEFAULT} )
-  get_property( _feature_desc GLOBAL PROPERTY _CMAKE_${_p_FEATURE}_DESCRIPTION )
-  if( _feature_desc )
-    add_feature_info( ${_p_FEATURE} ENABLE_${_p_FEATURE} "${_feature_desc}, ${PROJECT_NAME}: ${_p_DESCRIPTION}" )
-  else()
-    add_feature_info( ${_p_FEATURE} ENABLE_${_p_FEATURE} "${PROJECT_NAME}: ${_p_DESCRIPTION}" )
-  endif()
 
   ecbuild_debug("ecbuild_add_option(${_p_FEATURE}): defining option ENABLE_${_p_FEATURE} '${_p_DESCRIPTION}' ${_p_DEFAULT}")
   ecbuild_debug("ecbuild_add_option(${_p_FEATURE}): ENABLE_${_p_FEATURE}=${ENABLE_${_p_FEATURE}}")
@@ -176,6 +170,26 @@ macro( ecbuild_add_option )
     set( ENABLE_${_p_FEATURE} ${${PNAME}_ENABLE_${_p_FEATURE}} )
   endif()
 
+  ## Update the description of the feature summary
+  # Choose the correct tick
+  if (ENABLE_${_p_FEATURE})
+    set ( _tick "✔")
+  else()
+    set ( _tick "✘")
+  endif()
+  set(_enabled "${ENABLE_${_p_FEATURE}}")
+  get_property( _enabled_features GLOBAL PROPERTY ENABLED_FEATURES )
+  if( "${_p_FEATURE}" IN_LIST _enabled_features )
+    set(_enabled ON)
+  endif()
+  # Retrieve any existing description (n.b. occurs when the same feature is added at multiple projects)
+  get_property( _feature_desc GLOBAL PROPERTY _CMAKE_${_p_FEATURE}_DESCRIPTION )
+  # Append the new description
+  if( _feature_desc )
+    add_feature_info( ${_p_FEATURE} ${_enabled} "${_feature_desc}, ${PROJECT_NAME}(${_tick}): '${_p_DESCRIPTION}'" )
+  else()
+    add_feature_info( ${_p_FEATURE} ${_enabled} "${PROJECT_NAME}(${_tick}): '${_p_DESCRIPTION}'" )
+  endif()
 
   set( ${PROJECT_NAME}_HAVE_${_p_FEATURE} 0 )
 
@@ -250,7 +264,7 @@ macro( ecbuild_add_option )
 
     else() # if user provided input and we cannot satisfy FAIL otherwise WARN
 
-      ecbuild_disable_feature( ${_p_FEATURE} )
+      ecbuild_disable_unused_feature( ${_p_FEATURE} )
 
       if( ${_p_FEATURE}_user_provided_input )
         if( NOT _${_p_FEATURE}_condition )
@@ -267,16 +281,16 @@ macro( ecbuild_add_option )
           ecbuild_info( "Feature ${_p_FEATURE} was not enabled (also not requested) -- following required packages weren't found: ${_failed_to_find_packages}" )
         endif()
         set( ENABLE_${_p_FEATURE} OFF )
-        ecbuild_disable_feature( ${_p_FEATURE} )
+        ecbuild_disable_unused_feature( ${_p_FEATURE} )
       endif()
 
     endif()
 
   else()
 
-    ecbuild_debug("ecbuild_add_option(${_p_FEATURE}): feature disabled")
+    ecbuild_info( "Feature ${_p_FEATURE} disabled" )
     set( ${PROJECT_NAME}_HAVE_${_p_FEATURE} 0 )
-    ecbuild_disable_feature( ${_p_FEATURE} )
+    ecbuild_disable_unused_feature( ${_p_FEATURE} )
 
   endif()
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		dependency_branch: develop
		parallelism_factor: 8