Skip to content

Commit 2787e28

Browse files
committed
Update README
1 parent cdae2d0 commit 2787e28

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fswiftkube%2Fclient%2Fbadge%3Ftype%3Dplatforms"/>
1111
</a>
1212
<a href="https://v1-28.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/">
13-
<img src="https://img.shields.io/badge/Kubernetes-1.28.0-blue.svg" alt="Kubernetes 1.28.0"/>
13+
<img src="https://img.shields.io/badge/Kubernetes-1.28.3-blue.svg" alt="Kubernetes 1.28.3"/>
1414
</a>
1515
<a href="https://swift.org/package-manager">
1616
<img src="https://img.shields.io/badge/SwiftPM-compatible-brightgreen.svg?style=flat" alt="Swift Package Manager" />
@@ -42,7 +42,7 @@
4242
Swift client for talking to a [Kubernetes](http://kubernetes.io/) cluster via a fluent DSL based
4343
on [SwiftNIO](https://github.com/apple/swift-nio) and the [AysncHTTPClient](https://github.com/swift-server/async-http-client).
4444

45-
- [x] Covers all Kubernetes API Groups in v1.28.0
45+
- [x] Covers all Kubernetes API Groups in v1.28.3
4646
- [x] Automatic configuration discovery
4747
- [x] DSL style API
4848
- [x] For all API Groups/Versions
@@ -68,16 +68,17 @@ on [SwiftNIO](https://github.com/apple/swift-nio) and the [AysncHTTPClient](http
6868

6969
## Compatibility Matrix
7070

71-
| | 1.18.9 | 1.19.8 | 1.20.9 | 1.22.7 | 1.24.8 | 1.24.10 | 1.26.4 | 1.28.0 |
72-
|-------------------|--------|--------|--------|--------|--------|---------|--------|--------|
73-
| `0.6.x` || - | - | - | - | - | - | - |
74-
| `0.7.x...0.9.x` | - || - | - | - | - | - | - |
75-
| `0.10.x` | - | - || - | - | - | - | - |
76-
| `0.11.x` | - | - | - || - | - | - | - |
77-
| `0.12.x...0.13.x` | - | - | - | - || - | - | - |
78-
| `0.14.x` | - | - | - | - | - || - | - |
79-
| `0.15.x` | - | - | - | - | - | - || - |
80-
| `0.16.x` | - | - | - | - | - | - | - ||
71+
| | 1.18.9 | 1.19.8 | 1.20.9 | 1.22.7 | 1.24.8 | 1.24.10 | 1.26.4 | 1.28.0 | 1.28.3 |
72+
|-------------------|--------|--------|--------|--------|--------|---------|--------|--------|--------|
73+
| `0.6.x` || - | - | - | - | - | - | - | - |
74+
| `0.7.x...0.9.x` | - || - | - | - | - | - | - | - |
75+
| `0.10.x` | - | - || - | - | - | - | - | - |
76+
| `0.11.x` | - | - | - || - | - | - | - | - |
77+
| `0.12.x...0.13.x` | - | - | - | - || - | - | - | - |
78+
| `0.14.x` | - | - | - | - | - || - | - | - |
79+
| `0.15.x` | - | - | - | - | - | - || - | - |
80+
| `0.16.x` | - | - | - | - | - | - | - || - |
81+
| `0.17.x` | - | - | - | - | - | - | - | - ||
8182

8283
- `` Exact match of API objects in both client and the Kubernetes version.
8384
- `-` API objects mismatches either due to the removal of old API or the addition of new API. However, everything the
@@ -546,7 +547,7 @@ app.get("metrics") { request -> EventLoopFuture<String> in
546547
To use the `SwiftkubeClient` in a SwiftPM project, add the following line to the dependencies in your `Package.swift` file:
547548

548549
```swift
549-
.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.16.0")
550+
.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.17.0")
550551
```
551552

552553
then include it as a dependency in your target:
@@ -557,7 +558,7 @@ import PackageDescription
557558
let package = Package(
558559
// ...
559560
dependencies: [
560-
.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.16.0")
561+
.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.17.0")
561562
],
562563
targets: [
563564
.target(name: "<your-target>", dependencies: [

Sources/SwiftkubeClient/Watch/SwiftkubeClientTask.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import SwiftkubeModel
2323
// MARK: - SwiftkubeClientTask
2424

2525
/// A Client task, which is created by the SwiftkubeClient in the context of ``GenericKubernetesClient/watch(in:options:retryStrategy:)``
26-
/// or ``GenericKubernetesClient/follow(in:name:container:retryStrategy:)`` API requests.
26+
/// or ``GenericKubernetesClient/follow(in:name:container:timestamps:retryStrategy:)`` API requests.
2727
///
2828
/// The task instance must be started explicitly via ``SwiftkubeClientTask/start()``, which returns an
2929
/// ``AsyncThrowingStream``, that starts yielding items immediately as they are received from the Kubernetes API server.
@@ -35,7 +35,7 @@ import SwiftkubeModel
3535
///
3636
/// The task is executed indefinitely. Upon encountering non-transient errors this tasks reconnects to the
3737
/// Kubernetes API server, basically restarting the previous ``GenericKubernetesClient/watch(in:options:retryStrategy:)``
38-
/// or ``GenericKubernetesClient/follow(in:name:container:retryStrategy:)`` call.
38+
/// or ``GenericKubernetesClient/follow(in:name:container:timestamps:retryStrategy:)`` call.
3939
///
4040
/// The retry semantics are controlled via the passed ``RetryStrategy`` instance by the Kubernetes client.
4141
///

0 commit comments

Comments
 (0)