feat: Require Swift DocC only when env var is set (#1498)

awslabs · May 14, 2024 · f62ceed · f62ceed
1 parent 7824221
commit f62ceed
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/.github/workflows/generate-documentation.yml b/.github/workflows/generate-documentation.yml
@@ -17,6 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     container: swift:5.10-jammy
     env:
+      AWS_SWIFT_SDK_ENABLE_DOCC: 1
       IGNORE: none
     outputs:
       version: ${{ steps.set-version.outputs.version }}

diff --git a/AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.swift b/AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.swift
@@ -95,6 +95,7 @@ func addCRTDependency(_ version: Version) {
 }
 
 func addDoccDependency() {
+    guard ProcessInfo.processInfo.environment["AWS_SWIFT_SDK_ENABLE_DOCC"] != nil else { return }
     package.dependencies += [
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
     ]

diff --git a/Package.swift b/Package.swift
@@ -95,6 +95,7 @@ func addCRTDependency(_ version: Version) {
 }
 
 func addDoccDependency() {
+    guard ProcessInfo.processInfo.environment["AWS_SWIFT_SDK_ENABLE_DOCC"] != nil else { return }
     package.dependencies += [
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
     ]