mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Add CMake build support to the project to enable toolchain integration and bootstrapping compatibility. ### Motivation: Currently, swift-log does not support building with CMake. This addition resolves issue #484, allowing swift-log to be resolved and compiled within CMake-based environments (like the repos swift-certificates and swift-argument-parser which aer mentioned in the issue). ### Modifications: 1. **Project Root Config:** Added [CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/CMakeLists.txt) configuring the CMake project with Swift 6 and C, alongside setting up compiler flags for MSVC runtime library on Windows. 2. **Helper Modules:** Added the `cmake/` folder: - `SwiftSupport.cmake`: dylib/module installations and triple detection helper. - `SwiftLogConfig.cmake.in`: package config export templates. 3. **Target CMake Configurations:** Created [Sources/Logging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/Logging/CMakeLists.txt) & [Sources/InMemoryLogging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/InMemoryLogging/CMakeLists.txt) to define the library targets. Included generator expressions pointing `INTERFACE_INCLUDE_DIRECTORIES` to target output directories for Xcode generator support. 4. **SwiftPM Exclusions:** Excluded the new CMake files from target targets inside [Package.swift](file:///Users/adityamitra/Developer/swift-log/Package.swift) and [Package@swift-6.1.swift](file:///Users/adityamitra/Developer/swift-log/Package@swift-6.1.swift) to keep SwiftPM targets warning-free. 5. **Compile Options Variable:** Consolidates compile options under a single global definition `SWIFT_LOG_COMMON_COMPILE_OPTIONS` in the root configuration, enabling Swift 6 compiler features (`ExistentialAny`, `MemberImportVisibility`, `InternalImportsByDefault`, `NonisolatedNonsendingByDefault`, and explicit Sendable checks) across all targets. 6. **CI Integration & Workflow:** Integrated CMake CI validation in `.github/workflows/pull_request.yml` using the shared workflow from `apple/swift-nio/.github/workflows/cmake_tests.yml@main` running in a `swift:6.1-jammy` container. This job compiles the core libraries and verifies the validity of the CMake files. 7. **License Header Compliance:** Cleaned up license headers across all CMake files ### Result: * **SwiftPM:** All 164 unit tests compile and pass successfully under `swift test` with no warnings. * **CMake:** Successfully compiles (`** BUILD SUCCEEDED **`) under Xcode generator (`cmake -B build -G Xcode && cmake --build build`). ### Issue Tracking: Fixes #484 --------- Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
103 lines
4.0 KiB
YAML
103 lines
4.0 KiB
YAML
name: PR
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
on:
|
|
pull_request:
|
|
types: [opened, reopened, synchronize]
|
|
|
|
jobs:
|
|
soundness:
|
|
name: Soundness
|
|
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.13
|
|
with:
|
|
license_header_check_project_name: "Swift Logging API"
|
|
|
|
unit-tests:
|
|
name: Unit tests
|
|
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
|
|
with:
|
|
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
linux_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
linux_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
windows_6_1_enabled: true
|
|
windows_6_2_enabled: true
|
|
windows_6_3_enabled: true
|
|
windows_nightly_next_enabled: true
|
|
windows_nightly_main_enabled: true
|
|
windows_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
windows_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
windows_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
|
|
|
macos-benchmarks:
|
|
name: macOS benchmarks
|
|
uses: apple/swift-nio/.github/workflows/macos_benchmarks.yml@main
|
|
with:
|
|
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
|
|
macos_runner_pool: general
|
|
macos_swift_6_3_enabled: true
|
|
|
|
cxx-interop:
|
|
name: Cxx interop
|
|
uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
|
|
|
|
static-linux:
|
|
name: Static Linux Swift SDK
|
|
# Workaround https://github.com/nektos/act/issues/1875
|
|
uses: apple/swift-nio/.github/workflows/static_sdk.yml@main
|
|
|
|
macos-tests:
|
|
name: macOS tests
|
|
uses: apple/swift-nio/.github/workflows/macos_tests.yml@main
|
|
with:
|
|
runner_pool: general
|
|
build_scheme: swift-log-Package
|
|
swift_test_enabled: true
|
|
swift_6_1_enabled: true
|
|
swift_6_2_enabled: true
|
|
swift_6_3_enabled: true
|
|
macos_xcode_test_enabled: true
|
|
ios_xcode_test_enabled: true
|
|
watchos_xcode_test_enabled: true
|
|
tvos_xcode_test_enabled: true
|
|
visionos_xcode_test_enabled: true
|
|
|
|
android:
|
|
name: Android Swift SDK
|
|
# Workaround https://github.com/nektos/act/issues/1875
|
|
uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
|
|
|
|
release-builds:
|
|
name: Release builds
|
|
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
|
|
with:
|
|
windows_6_1_enabled: true
|
|
windows_6_2_enabled: true
|
|
windows_6_3_enabled: true
|
|
windows_nightly_next_enabled: true
|
|
windows_nightly_main_enabled: true
|
|
|
|
wasm:
|
|
name: Wasm Swift SDK
|
|
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
|
|
with:
|
|
nightly_next_enabled: false
|
|
|
|
cmake-lists:
|
|
name: Check CMake Lists
|
|
uses: apple/swift-nio/.github/workflows/cmake_tests.yml@main
|
|
with:
|
|
image: "swift:6.1-jammy"
|
|
update_cmake_lists_config: >-
|
|
{
|
|
"targets": [
|
|
{ "name": "Logging", "type": "source", "exceptions": [] },
|
|
{ "name": "InMemoryLogging", "type": "source", "exceptions": [] }
|
|
]
|
|
}
|