Skip to content

Commit 7b1c29f

Browse files
authored
[Docs] Recommend .upToNextMinor before we tag 1.0 (#7)
[Docs] Recommend .upToNextMinor before we tag 1.0 ### Motivation In our detailed docs, we do recommend adopters use `.upToNextMinor(from: "...")` before we tag 1.0, but our README and getting started docs still used `from` (aka `.upToNextMajor`). ### Modifications Updated the docs to use `.upToNextMinor` ### Result Now adopters should use that recommendation and only upgrade between minor versions manually. ### Test Plan Previewed locally, looks good. Reviewed by: simonjbeaumont, simonjbeaumont Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #7
1 parent 24d66e0 commit 7b1c29f

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,15 @@ It contains:
1313
Add the package dependency in your `Package.swift`:
1414

1515
```swift
16-
.package(url: "https://github.com/apple/swift-openapi-runtime", from: "0.1.0"),
16+
.package(
17+
url: "https://github.com/apple/swift-openapi-runtime",
18+
.upToNextMinor(from: "0.1.0")
19+
),
1720
```
1821

19-
and in your target, add `OpenAPIRuntime` to your dependencies:
22+
Note that this repository does not have a 1.0 tag yet, so the API is not stable.
23+
24+
Next, in your target, add `OpenAPIRuntime` to your dependencies:
2025

2126
```swift
2227
.target(name: "MyTarget", dependencies: [

Sources/OpenAPIRuntime/Documentation.docc/Documentation.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,15 @@ It contains:
1515
Add the package dependency in your `Package.swift`:
1616

1717
```swift
18-
.package(url: "https://github.com/apple/swift-openapi-runtime", from: "0.1.0"),
18+
.package(
19+
url: "https://github.com/apple/swift-openapi-runtime",
20+
.upToNextMinor(from: "0.1.0")
21+
),
1922
```
2023

21-
and in your target, add `OpenAPIRuntime` to your dependencies:
24+
Note that this repository does not have a 1.0 tag yet, so the API is not stable.
25+
26+
Next, in your target, add `OpenAPIRuntime` to your dependencies:
2227

2328
```swift
2429
.target(name: "MyTarget", dependencies: [

0 commit comments

Comments
 (0)