Add support for Swift Package Index document generation

lorenzofiamingo · web-flow · commit 467a3d174798 · 2022-06-09T13:12:28.000+02:00
diff --git a/.spi.yml b/.spi.yml
@@ -0,0 +1,4 @@
+version: 1
+builder:
+  configs:
+    - documentation_targets: ["CachedAsyncImage"]
diff --git a/Package.resolved b/Package.resolved
@@ -0,0 +1,14 @@
+{
+  "pins" : [
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin",
+      "state" : {
+        "revision" : "3303b164430d9a7055ba484c8ead67a52f7b74f6",
+        "version" : "1.0.0"
+      }
+    }
+  ],
+  "version" : 2
+}
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.6
 
 import PackageDescription
 
@@ -19,3 +19,10 @@ let package = Package(
         .target(name: "CachedAsyncImage")
     ]
 )
+
+#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

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// swift-tools-version:5.5`
	`1`	`+// swift-tools-version:5.6`
`2`	`2`
`3`	`3`	`import PackageDescription`
`4`	`4`
`@@ -19,3 +19,10 @@ let package = Package(`
`19`	`19`	`.target(name: "CachedAsyncImage")`
`20`	`20`	`]`
`21`	`21`	`)`
	`22`	`+`
	`23`	`+#if swift(>=5.6)`
	`24`	`+// Add the documentation compiler plugin if possible`
	`25`	`+package.dependencies.append(`
	`26`	`+ .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")`
	`27`	`+)`
	`28`	`+#endif`