From b8d0de29239ca33c3e9a5e21ecbcd5defe2da654 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Tue, 15 Apr 2025 12:33:55 -0700 Subject: [PATCH 1/2] [docs] adds the swift-docc-plugin dependency to the package - makes it easier to preview documentation changes - added detail on how to preview into the README within the documentation target --- Package.swift | 1 + Sources/ContainerImageBuilderPluginDocumentation/README.md | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/Package.swift b/Package.swift index aef81bc..a334ac4 100644 --- a/Package.swift +++ b/Package.swift @@ -27,6 +27,7 @@ let package = Package( .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0"..<"4.0.0"), .package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"), .package(url: "https://github.com/apple/swift-http-types.git", from: "1.2.0"), + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0") ], targets: [ .target( diff --git a/Sources/ContainerImageBuilderPluginDocumentation/README.md b/Sources/ContainerImageBuilderPluginDocumentation/README.md index 42af32f..204a434 100644 --- a/Sources/ContainerImageBuilderPluginDocumentation/README.md +++ b/Sources/ContainerImageBuilderPluginDocumentation/README.md @@ -3,4 +3,10 @@ `ContainerImageBuilderPluginDocumentation` is an otherwise empty target that includes high-level, user-facing documentation about using the ContainerImageBuilder plugin from the command-line. +To preview the documentation, run the following command: + +```bash +swift package --disable-sandbox preview-documentation --target ContainerImageBuilderPlugin +``` + From a2401a7dae09760500fb3d8aefd0b8196320ad15 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Tue, 15 Apr 2025 13:26:15 -0700 Subject: [PATCH 2/2] fix for soundness check --- Package.swift | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Package.swift b/Package.swift index a334ac4..e90006c 100644 --- a/Package.swift +++ b/Package.swift @@ -27,7 +27,7 @@ let package = Package( .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0"..<"4.0.0"), .package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"), .package(url: "https://github.com/apple/swift-http-types.git", from: "1.2.0"), - .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0") + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"), ], targets: [ .target(