Skip to content

Fix SPI doc build issue #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kyle-Ye merged 1 commit into from
Jun 9, 2025
Merged

Fix SPI doc build issue #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ func envEnable(_ key: String, default defaultValue: Bool = false) -> Bool {
}
}

#if os(macOS)
// NOTE: #if os(macOS) check is not accurate if we are cross compiling for Linux platform. So we add an env key to specify it.
let buildForDarwinPlatform = envEnable("OPENSWIFTUI_BUILD_FOR_DARWIN_PLATFORM", default: true)
#else
let buildForDarwinPlatform = envEnable("OPENSWIFTUI_BUILD_FOR_DARWIN_PLATFORM")
#endif


// https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/3061#issuecomment-2118821061
// By-pass https://github.com/swiftlang/swift-package-manager/issues/7580
let isSPIDocGenerationBuild = envEnable("SPI_GENERATE_DOCS", default: false)

// MARK: - Env and Config

let isXcodeEnv = Context.environment["__CFBundleIdentifier"] == "com.apple.dt.Xcode"
Expand Down Expand Up @@ -44,11 +56,7 @@ var sharedSwiftSettings: [SwiftSetting] = [

// MARK: - [env] OPENBOX_LIBRARY_EVOLUTION

#if os(macOS)
let libraryEvolutionCondition = envEnable("OPENBOX_LIBRARY_EVOLUTION", default: true)
#else
let libraryEvolutionCondition = envEnable("OPENBOX_LIBRARY_EVOLUTION")
#endif
let libraryEvolutionCondition = envEnable("OPENBOX_LIBRARY_EVOLUTION", default: buildForDarwinPlatform)

if libraryEvolutionCondition {
// NOTE: -enable-library-evolution will cause module verify failure for `swift build`.
Expand Down Expand Up @@ -115,14 +123,10 @@ let package = Package(
cxxLanguageStandard: .cxx20
)


#if os(macOS)
let renderBoxCondtion = envEnable("OPENBOX_RENDERBOX", default: true)
#else
let renderBoxCondtion = envEnable("OPENBOX_RENDERBOX")
#endif
let useLocalDeps = envEnable("OPENBOX_USE_LOCAL_DEPS")

let renderBoxCondtion = envEnable("OPENBOX_RENDERBOX", default: buildForDarwinPlatform && !isSPIDocGenerationBuild )

if renderBoxCondtion {
let privateFrameworkRepo: Package.Dependency
if useLocalDeps {
Expand Down