Add Package.swift for 5.4 and 5.5 that excludes documentation (#124)

* Add packages for 5.4 and 5.5

* Update documentation build script

* Exclude MQTTNIO.docc in 5.4/5.5 Package

* rename package.swifts

Author: adam-fowler

.devcontainer/devcontainer.json

@@ -4,9 +4,9 @@
     "service": "app",
     "workspaceFolder": "/workspace",
     "extensions": [
-      "sswg.swift-lang",
+      "sswg.swift-lang"
     ],
     "settings": {
       "lldb.library": "/usr/lib/liblldb.so"
-    },
+    }
 }

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.3
+// swift-tools-version:5.6
 
 import PackageDescription
 
@@ -14,6 +14,7 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.42.0"),
         .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.14.0"),
         .package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.6.0"),
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: [
         .target(
@@ -33,10 +34,3 @@ let package = Package(
         .testTarget(name: "MQTTNIOTests", dependencies: ["MQTTNIO"]),
     ]
 )
-
-#if swift(>=5.6)
-// Add the documentation compiler plugin if possible
-package.dependencies.append(
-    .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
-)
-#endif

[email protected]

@@ -0,0 +1,36 @@
+// swift-tools-version:5.4
+
+import PackageDescription
+
+let package = Package(
+    name: "mqtt-nio",
+    platforms: [.macOS(.v10_14), .iOS(.v12), .tvOS(.v12), .watchOS(.v6)],
+    products: [
+        .library(name: "MQTTNIO", targets: ["MQTTNIO"]),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-atomics.git", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.42.0"),
+        .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.14.0"),
+        .package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.6.0"),
+    ],
+    targets: [
+        .target(
+            name: "MQTTNIO",
+            dependencies:
+            [
+                .product(name: "Atomics", package: "swift-atomics"),
+                .product(name: "Logging", package: "swift-log"),
+                .product(name: "NIO", package: "swift-nio"),
+                .product(name: "NIOConcurrencyHelpers", package: "swift-nio"),
+                .product(name: "NIOHTTP1", package: "swift-nio"),
+                .product(name: "NIOWebSocket", package: "swift-nio"),
+                .product(name: "NIOSSL", package: "swift-nio-ssl", condition: .when(platforms: [.linux, .macOS])),
+                .product(name: "NIOTransportServices", package: "swift-nio-transport-services"),
+            ],
+            exclude: ["MQTTNIO.docc"]
+        ),
+        .testTarget(name: "MQTTNIOTests", dependencies: ["MQTTNIO"]),
+    ]
+)

[email protected]

@@ -0,0 +1,36 @@
+// swift-tools-version:5.5
+
+import PackageDescription
+
+let package = Package(
+    name: "mqtt-nio",
+    platforms: [.macOS(.v10_14), .iOS(.v12), .tvOS(.v12), .watchOS(.v6)],
+    products: [
+        .library(name: "MQTTNIO", targets: ["MQTTNIO"]),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-atomics.git", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.42.0"),
+        .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.14.0"),
+        .package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.6.0"),
+    ],
+    targets: [
+        .target(
+            name: "MQTTNIO",
+            dependencies:
+            [
+                .product(name: "Atomics", package: "swift-atomics"),
+                .product(name: "Logging", package: "swift-log"),
+                .product(name: "NIO", package: "swift-nio"),
+                .product(name: "NIOConcurrencyHelpers", package: "swift-nio"),
+                .product(name: "NIOHTTP1", package: "swift-nio"),
+                .product(name: "NIOWebSocket", package: "swift-nio"),
+                .product(name: "NIOSSL", package: "swift-nio-ssl", condition: .when(platforms: [.linux, .macOS])),
+                .product(name: "NIOTransportServices", package: "swift-nio-transport-services"),
+            ],
+            exclude: ["MQTTNIO.docc"]
+        ),
+        .testTarget(name: "MQTTNIOTests", dependencies: ["MQTTNIO"]),
+    ]
+)

scripts/build-docc.sh

@@ -13,53 +13,4 @@ usePlugin()
         --hosting-base-path /mqtt-nio
 }
 
-TEMP_DIR="$(pwd)/temp"
-
-cleanup()
-{
-    if [ -n "$TEMP_DIR" ]; then
-        rm -rf $TEMP_DIR
-    fi
-}
-trap cleanup exit $?
-
-SG_FOLDER=.build/symbol-graphs
-MQTTNIO_SG_FOLDER=.build/mqtt-nio-symbol-graphs
-OUTPUT_PATH=docs/mqtt-nio/
-
-BUILD_SYMBOLS=1
-
-while getopts 's' option
-do
-    case $option in
-        s) BUILD_SYMBOLS=0;;
-    esac
-done
-
-if [ -z "${DOCC_HTML_DIR:-}" ]; then
-    git clone https://github.com/apple/swift-docc-render-artifact $TEMP_DIR/swift-docc-render-artifact
-     export DOCC_HTML_DIR="$TEMP_DIR/swift-docc-render-artifact/dist"
-fi
-
-if test "$BUILD_SYMBOLS" == 1; then
-    # build symbol graphs
-    mkdir -p $SG_FOLDER
-    swift build \
-        -Xswiftc -emit-symbol-graph \
-        -Xswiftc -emit-symbol-graph-dir -Xswiftc $SG_FOLDER
-    # Copy MQTTNIO symbol graph into separate folder
-    mkdir -p $MQTTNIO_SG_FOLDER
-    cp $SG_FOLDER/MQTTNIO* $MQTTNIO_SG_FOLDER
-fi
-
-# Build documentation
-mkdir -p $OUTPUT_PATH
-rm -rf $OUTPUT_PATH/*
-docc convert Sources/MQTTNIO/MQTTNIO.docc \
-    --transform-for-static-hosting \
-    --hosting-base-path /mqtt-nio \
-    --fallback-display-name MQTTNIO \
-    --fallback-bundle-identifier org.swift-server-community.mqtt-nio \
-    --fallback-bundle-version 1 \
-    --additional-symbol-graph-dir $MQTTNIO_SG_FOLDER \
-    --output-path $OUTPUT_PATH
+usePlugin