From 2787e28749b8e2a2c67f898984c2dbfe8553390f Mon Sep 17 00:00:00 2001 From: Iskandar Abudiab Date: Sun, 5 Nov 2023 20:24:16 +0100 Subject: [PATCH] Update README --- README.md | 29 ++++++++++--------- .../Watch/SwiftkubeClientTask.swift | 4 +-- 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6c28bbf..ff5c704 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ - Kubernetes 1.28.0 + Kubernetes 1.28.3 Swift Package Manager @@ -42,7 +42,7 @@ Swift client for talking to a [Kubernetes](http://kubernetes.io/) cluster via a fluent DSL based on [SwiftNIO](https://github.com/apple/swift-nio) and the [AysncHTTPClient](https://github.com/swift-server/async-http-client). -- [x] Covers all Kubernetes API Groups in v1.28.0 +- [x] Covers all Kubernetes API Groups in v1.28.3 - [x] Automatic configuration discovery - [x] DSL style API - [x] For all API Groups/Versions @@ -68,16 +68,17 @@ on [SwiftNIO](https://github.com/apple/swift-nio) and the [AysncHTTPClient](http ## Compatibility Matrix -| | 1.18.9 | 1.19.8 | 1.20.9 | 1.22.7 | 1.24.8 | 1.24.10 | 1.26.4 | 1.28.0 | -|-------------------|--------|--------|--------|--------|--------|---------|--------|--------| -| `0.6.x` | ✓ | - | - | - | - | - | - | - | -| `0.7.x...0.9.x` | - | ✓ | - | - | - | - | - | - | -| `0.10.x` | - | - | ✓ | - | - | - | - | - | -| `0.11.x` | - | - | - | ✓ | - | - | - | - | -| `0.12.x...0.13.x` | - | - | - | - | ✓ | - | - | - | -| `0.14.x` | - | - | - | - | - | ✓ | - | - | -| `0.15.x` | - | - | - | - | - | - | ✓ | - | -| `0.16.x` | - | - | - | - | - | - | - | ✓ | +| | 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 | +|-------------------|--------|--------|--------|--------|--------|---------|--------|--------|--------| +| `0.6.x` | ✓ | - | - | - | - | - | - | - | - | +| `0.7.x...0.9.x` | - | ✓ | - | - | - | - | - | - | - | +| `0.10.x` | - | - | ✓ | - | - | - | - | - | - | +| `0.11.x` | - | - | - | ✓ | - | - | - | - | - | +| `0.12.x...0.13.x` | - | - | - | - | ✓ | - | - | - | - | +| `0.14.x` | - | - | - | - | - | ✓ | - | - | - | +| `0.15.x` | - | - | - | - | - | - | ✓ | - | - | +| `0.16.x` | - | - | - | - | - | - | - | ✓ | - | +| `0.17.x` | - | - | - | - | - | - | - | - | ✓ | - `✓` Exact match of API objects in both client and the Kubernetes version. - `-` 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 in To use the `SwiftkubeClient` in a SwiftPM project, add the following line to the dependencies in your `Package.swift` file: ```swift -.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.16.0") +.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.17.0") ``` then include it as a dependency in your target: @@ -557,7 +558,7 @@ import PackageDescription let package = Package( // ... dependencies: [ - .package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.16.0") + .package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.17.0") ], targets: [ .target(name: "", dependencies: [ diff --git a/Sources/SwiftkubeClient/Watch/SwiftkubeClientTask.swift b/Sources/SwiftkubeClient/Watch/SwiftkubeClientTask.swift index f6fd848..45ecfb9 100644 --- a/Sources/SwiftkubeClient/Watch/SwiftkubeClientTask.swift +++ b/Sources/SwiftkubeClient/Watch/SwiftkubeClientTask.swift @@ -23,7 +23,7 @@ import SwiftkubeModel // MARK: - SwiftkubeClientTask /// A Client task, which is created by the SwiftkubeClient in the context of ``GenericKubernetesClient/watch(in:options:retryStrategy:)`` -/// or ``GenericKubernetesClient/follow(in:name:container:retryStrategy:)`` API requests. +/// or ``GenericKubernetesClient/follow(in:name:container:timestamps:retryStrategy:)`` API requests. /// /// The task instance must be started explicitly via ``SwiftkubeClientTask/start()``, which returns an /// ``AsyncThrowingStream``, that starts yielding items immediately as they are received from the Kubernetes API server. @@ -35,7 +35,7 @@ import SwiftkubeModel /// /// The task is executed indefinitely. Upon encountering non-transient errors this tasks reconnects to the /// Kubernetes API server, basically restarting the previous ``GenericKubernetesClient/watch(in:options:retryStrategy:)`` -/// or ``GenericKubernetesClient/follow(in:name:container:retryStrategy:)`` call. +/// or ``GenericKubernetesClient/follow(in:name:container:timestamps:retryStrategy:)`` call. /// /// The retry semantics are controlled via the passed ``RetryStrategy`` instance by the Kubernetes client. ///