mirror of
https://github.com/apple/swift-asn1
synced 2026-11-22 04:10:39 +00:00
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.
This commit is contained in:
1 parent
6cac4d424c
commit
6578d7acfc
5 files changed
+26
-99
No files matched your search
@@ -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": [] }
|
||||
]
|
||||
}
|
||||
@@ -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.
|
||||
@@ -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
|
||||
$<$<NOT:$<PLATFORM_ID:Darwin>>:dispatch>
|
||||
|
||||
@@ -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."
|
||||
@@ -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<num_exts; i++ ));
|
||||
do
|
||||
exts_arg+=(-o -name "${src_exts[$i]}")
|
||||
done
|
||||
|
||||
# Wrap quotes around each filename since it might contain spaces
|
||||
srcs=$($find "${src_root}" -type f \( "${exts_arg[@]}" \) -printf ' "%P"\n' | LC_ALL=POSIX sort)
|
||||
echo "$srcs"
|
||||
|
||||
# Update list of source files in CMakeLists.txt
|
||||
# The first part in `BEGIN` (i.e., `undef $/;`) is for working with multi-line;
|
||||
# the second is so that we can pass in a variable to replace with.
|
||||
perl -pi -e 'BEGIN { undef $/; $replace = shift } s/add_library\(([^\n]+)\n([^\)]+)/add_library\($1\n$replace/' "$srcs" "$src_root/CMakeLists.txt"
|
||||
echo "Updated $src_root/CMakeLists.txt"
|
||||
}
|
||||
|
||||
update_cmakelists_source "SwiftASN1" "*.swift"
|
||||
Reference in new issue
Block a user