Skip to content

Commit 6bda27e

Browse files
committed
Prepare 0.1.0 release
Motivation: Bring the repo in a state for an initial 0.1.0 release. Modifications: * Use tagged releases for dependencies. * Clarify versioning in README. * Update snippet accordingly. Results: Ready, set, ...
1 parent f56ced6 commit 6bda27e

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

Package.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ let package = Package(
3434
.package(url: "https://github.com/apple/swift-crypto.git", from: "5.0.0-beta.1"),
3535
.package(url: "https://github.com/apple/swift-certificates.git", from: "1.19.3"),
3636
.package(url: "https://github.com/apple/swift-nio-extras.git", from: "1.22.0"),
37-
.package(url: "https://github.com/apple/swift-nio-quic-helpers.git", branch: "main"),
38-
.package(url: "https://github.com/apple/swift-nio-quic.git", branch: "main"),
37+
.package(url: "https://github.com/apple/swift-nio-quic-helpers.git", .upToNextMinor(from: "0.1.0")),
38+
.package(url: "https://github.com/apple/swift-nio-quic.git", .upToNextMinor(from: "0.1.0")),
3939
],
4040
targets: [
4141
.target(

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ let package = Package(
2121
name: "Application",
2222
dependencies: [
2323
.package(url: "https://github.com/apple/swift-nio.git", from: "2.100.0"),
24-
.package(url: "https://github.com/apple/swift-nio-http3", branch: "main"),
25-
.package(url: "https://github.com/apple/swift-nio-quic", branch: "main"),
24+
.package(url: "https://github.com/apple/swift-nio-http3", .upToNextMinor(from: "0.1.0")),
25+
.package(url: "https://github.com/apple/swift-nio-quic", .upToNextMinor(from: "0.1.0")),
2626
],
2727
targets: [
2828
.executableTarget(
@@ -75,5 +75,13 @@ SWIFT_CERTIFICATES_ALLOW_SWIFT_CRYPTO_BETA=1 swift test --filter EncoderTests.ma
7575
Use `SWIFT_CERTIFICATES_ALLOW_SWIFT_CRYPTO_BETA=1 xed Package.swift` to open
7676
the project in Xcode with the environment variable set.
7777

78+
### Versioning
79+
80+
While the library is in the 0.x.x version range, you should adopt it using
81+
the `.upToNextMinor(from: "0.1.0")` specifier. During this period, breaking
82+
changes are intended to map to minor version bumps, so depending on the
83+
library this way picks up smaller, non-breaking changes automatically while
84+
protecting against API-breaking ones.
85+
7886
[swift-nio-quic]: https://github.com/apple/swift-nio-quic
7987
[swift-nio]: https://github.com/apple/swift-nio

0 commit comments

Comments
 (0)