From 6578d7acfce2f65f8d571dd104ad2b4ba71abea7 Mon Sep 17 00:00:00 2001 From: Rick Newton-Rogers Date: Mon, 17 Mar 2025 11:15:52 +0000 Subject: [PATCH] Use centralized CMake checks (#96) ### Motivation: We now have centrally-hosted CMake checks in the NIO repository which we should use to reduce maintenance. The new checks also increase coverage by performing a build with CMake as part of the checks. ### Modifications: * Use the new workflow * Commit formatting changes in the CMakeLists files from the new script * Document how to update the CMakeLists files * Remove the obsolete scripts ### Result: Better CI coverage. --- .github/workflows/pull_request.yml | 18 ++++++---- CONTRIBUTING.md | 13 +++++++ Sources/SwiftASN1/CMakeLists.txt | 3 +- scripts/check-cmake-lists.sh | 33 ----------------- scripts/update-cmake-lists.sh | 58 ------------------------------ 5 files changed, 26 insertions(+), 99 deletions(-) delete mode 100755 scripts/check-cmake-lists.sh delete mode 100755 scripts/update-cmake-lists.sh diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 525340c..86315e5 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -11,13 +11,6 @@ jobs: with: license_header_check_project_name: "SwiftASN1" - cmake-lists: - name: Check cmake lists - uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main - with: - name: "Check cmake lists" - matrix_linux_command: ./scripts/check-cmake-lists.sh - unit-tests: name: Unit tests uses: apple/swift-nio/.github/workflows/unit_tests.yml@main @@ -48,3 +41,14 @@ jobs: name: Static SDK # Workaround https://github.com/nektos/act/issues/1875 uses: apple/swift-nio/.github/workflows/static_sdk.yml@main + + cmake-lists: + name: Check cmake lists + uses: apple/swift-nio/.github/workflows/cmake_tests.yml@main + with: + update_cmake_lists_config: >- + { + "targets": [ + { "name": "SwiftASN1", "type": "source", "exceptions": [] } + ] + } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7578cd..221dd47 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,6 +65,19 @@ We require that your commit messages match our template. The easiest way to do t You can run the Github Actions workflows locally using [act](https://github.com/nektos/act). For detailed steps on how to do this please see [https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally](https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally). +### How to update CMakeLists files + +If you wish to update the CMakeLists files you can either do this by using [act](https://github.com/nektos/act) or calling the remotely hosted CI script. + +Issuing a command such as the following to `act` causes it to run the `cmake-lists` job locally which updates the CMakeLists files and if it finds no changes performs a build. The `--bind` flag means that the VM be acts on your local filesystem so be aware that this could delete/change files (including your git setup/branches). +``` +act --container-architecture linux/amd64 pull_request -j cmake-lists -W ./.github/workflows/pull_request.yml --bind +``` + +You can find the underlying script at https://github.com/apple/swift-nio/blob/main/scripts/update-cmake-lists.sh . Using the script directly is less straightforwards because it requires you to pass the JSON config from the `pull_request.yml` file into the script, such as: +``` +curl -s https://raw.githubusercontent.com/apple/swift-nio/main/scripts/update-cmake-lists.sh | CONFIG_JSON='{"targets":[{"name":"SwiftASN1","type":"source","exceptions":[]}]}' bash + ## How to contribute your work Please open a pull request at [https://github.com/apple/swift-asn1](https://github.com/apple/swift-asn1). Make sure the CI passes, and then wait for code review. diff --git a/Sources/SwiftASN1/CMakeLists.txt b/Sources/SwiftASN1/CMakeLists.txt index 1d42439..4babb0d 100644 --- a/Sources/SwiftASN1/CMakeLists.txt +++ b/Sources/SwiftASN1/CMakeLists.txt @@ -30,7 +30,8 @@ add_library(SwiftASN1 "Basic ASN1 Types/TimeUtilities.swift" "Basic ASN1 Types/UTCTime.swift" "DER.swift" - "Errors.swift") + "Errors.swift" +) target_link_libraries(SwiftASN1 PUBLIC $<$>:dispatch> diff --git a/scripts/check-cmake-lists.sh b/scripts/check-cmake-lists.sh deleted file mode 100755 index b8dcee0..0000000 --- a/scripts/check-cmake-lists.sh +++ /dev/null @@ -1,33 +0,0 @@ -#!/bin/bash -##===----------------------------------------------------------------------===## -## -## This source file is part of the SwiftASN1 open source project -## -## Copyright (c) 2024 Apple Inc. and the SwiftASN1 project authors -## Licensed under Apache License v2.0 -## -## See LICENSE.txt for license information -## See CONTRIBUTORS.txt for the list of SwiftASN1 project authors -## -## SPDX-License-Identifier: Apache-2.0 -## -##===----------------------------------------------------------------------===## - -set -euo pipefail - -log() { printf -- "** %s\n" "$*" >&2; } -error() { printf -- "** ERROR: %s\n" "$*" >&2; } -fatal() { error "$@"; exit 1; } - -log "Checking if the cmake files are up-to-date..." - -here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -FIRST_OUT="$(git status --porcelain)" -_=$("$here"/update-cmake-lists.sh 2>&1) -SECOND_OUT="$(git status --porcelain)" -if [[ "$FIRST_OUT" != "$SECOND_OUT" ]]; then - error "Changes in the cmake files detected. Please run the update-cmake-lists.sh script." - exit 1 -fi - -log "✅ cmake files are up-to-date." diff --git a/scripts/update-cmake-lists.sh b/scripts/update-cmake-lists.sh deleted file mode 100755 index 4dedeca..0000000 --- a/scripts/update-cmake-lists.sh +++ /dev/null @@ -1,58 +0,0 @@ -#!/bin/bash -##===----------------------------------------------------------------------===## -## -## This source file is part of the SwiftASN1 open source project -## -## Copyright (c) 2023 Apple Inc. and the SwiftASN1 project authors -## Licensed under Apache License v2.0 -## -## See LICENSE.txt for license information -## See CONTRIBUTORS.txt for the list of SwiftASN1 project authors -## -## SPDX-License-Identifier: Apache-2.0 -## -##===----------------------------------------------------------------------===## - -set -eu - -here=$(pwd) - -case "$(uname -s)" in - Darwin) - find=gfind # brew install findutils - ;; - *) - find='find' - ;; -esac - -function update_cmakelists_source() { - src_root="$here/Sources/$1" - - # Build an array with the rest of the arguments - shift - src_exts=("$@") - echo "Finding source files (" "${src_exts[@]}" ") under $src_root" - - num_exts=${#src_exts[@]} - - # Build file extensions argument for `find` - declare -a exts_arg - exts_arg+=(-name "${src_exts[0]}") - for (( i=1; i