Skip to content

Commit 0f39e17

Browse files
committed
docs: Update documentation links and examples after 1.0.0 release (#111)
Motivation ---------- The DoCC documentation was restructured substantially between 0.5.0 and 1.0.0, so the links in `README.md` are no longer correct. The examples should also point to the new release. Modifications ------------- * Update the links to the Swift Package Index documentation * Update example project dependencies * Stop asking SPI to build the `containertool` documentation target Result ------ Documentation links will be correct once Swift Package Index builds the new release. Test Plan --------- All existing tests continue to pass.
1 parent 53f2960 commit 0f39e17

File tree

5 files changed

+5
-6
lines changed

5 files changed

+5
-6
lines changed

.spi.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ version: 1
22
builder:
33
configs:
44
- documentation_targets:
5-
- containertool
65
- swift-container-plugin

Examples/HelloWorldHummingbird/Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ let package = Package(
2121
platforms: [.macOS(.v14)],
2222
dependencies: [
2323
.package(url: "https://github.com/hummingbird-project/hummingbird.git", from: "2.1.0"),
24-
.package(url: "https://github.com/apple/swift-container-plugin", from: "0.5.0"),
24+
.package(url: "https://github.com/apple/swift-container-plugin", from: "1.0.0"),
2525
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"),
2626
],
2727
targets: [

Examples/HelloWorldVapor/Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ let package = Package(
2121
platforms: [.macOS(.v13)],
2222
dependencies: [
2323
.package(url: "https://github.com/vapor/vapor", from: "4.102.0"),
24-
.package(url: "https://github.com/apple/swift-container-plugin", from: "0.5.0"),
24+
.package(url: "https://github.com/apple/swift-container-plugin", from: "1.0.0"),
2525
],
2626
targets: [.executableTarget(name: "hello-world", dependencies: [.product(name: "Vapor", package: "vapor")])]
2727
)

Examples/HelloWorldWithResources/Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ let package = Package(
2121
platforms: [.macOS(.v14)],
2222
dependencies: [
2323
.package(url: "https://github.com/hummingbird-project/hummingbird.git", from: "2.1.0"),
24-
.package(url: "https://github.com/apple/swift-container-plugin", from: "0.5.0"),
24+
.package(url: "https://github.com/apple/swift-container-plugin", from: "1.0.0"),
2525
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.3.0"),
2626
],
2727
targets: [

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Swift Container Plugin
22

3-
[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/apple/swift-container-plugin/documentation/containerimagebuilderplugin)
3+
[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/apple/swift-container-plugin/documentation/swift-container-plugin)
44
[![](https://img.shields.io/github/v/release/apple/swift-container-plugin?include_prereleases)](https://github.com/apple/swift-container-plugin/releases)
55
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-container-plugin%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/apple/swift-container-plugin)
66
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-container-plugin%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/apple/swift-container-plugin)
@@ -69,6 +69,6 @@ Trying to pull registry.example.com/myservice@sha256:a3f75d0932d052dd9d448a1c904
6969

7070
## Getting Started
7171

72-
Learn more about setting up your project in the [plugin documentation](https://swiftpackageindex.com/apple/swift-container-plugin/documentation/containerimagebuilderplugin).
72+
Learn more about setting up your project in the [plugin documentation](https://swiftpackageindex.com/apple/swift-container-plugin/documentation/swift-container-plugin).
7373

7474
Take a look at the [Examples](Examples).

0 commit comments

Comments
 (0)