Skip to content

Commit

Permalink
Update Readme and Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
iabudiab committed Sep 4, 2021
1 parent 156ac96 commit a90cdc0
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 13 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## 0.10.0

### New

- Update to Kubernetes model v1.20.9
- Add `LocalFileConfigLoader` for loading KubeConfigs from a local file given a URL #8 by @thomashorrobin
- Add support for `scale` and `status` API
- Setup CI with live K3d cluster and add several tests against it

### Bug Fixes

- Add missing support for `continue` token in `ListOption` for retrieving subsequent list results #9
- Track dependency on SwiftkubeModel up-to-next minor instead of major #10

## 0.9.0

- Add supported platforms for Swift package
Expand Down
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

<p align="center">
<img src="https://img.shields.io/badge/Swift-5.2-orange.svg" />
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/">
<img src="https://img.shields.io/badge/Kubernetes-1.19.8-blue.svg" alt="Kubernetes 1.18.13"/>
<a href="https://v1-20.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/">
<img src="https://img.shields.io/badge/Kubernetes-1.20.9-blue.svg" alt="Kubernetes 1.20.9"/>
</a>
<a href="https://swift.org/package-manager">
<img src="https://img.shields.io/badge/swiftpm-compatible-brightgreen.svg?style=flat" alt="Swift Package Manager" />
Expand Down Expand Up @@ -35,7 +35,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.19.8
- [x] Covers all Kubernetes API Groups in v1.20.9
- [x] Automatic configuration discovery
- [x] DSL style API
- [x] For all API Groups/Versions
Expand All @@ -48,8 +48,8 @@ Swift client for talking to a [Kubernetes](http://kubernetes.io/) cluster via a
- [x] List Options
- [x] Delete Options
- [ ] PATCH API
- [ ] `/scale` API
- [ ] `/status` API
- [x] `/scale` API
- [x] `/status` API
- [x] Resource watch support
- [x] Follow pod logs support
- [x] Discovery API
Expand All @@ -61,12 +61,13 @@ Swift client for talking to a [Kubernetes](http://kubernetes.io/) cluster via a

## Compatibility Matrix

| | <1.18.9 | 1.18.9 - 1.18.13 | 1.19.8 |
|---------------------------|---------|------------------|--------|
| SwiftkubeClient 0.6.x | - ||- |
| SwiftkubeClient 0.7.x | - | - ||
| SwiftkubeClient 0.8.x | - | - ||
| SwiftkubeClient 0.9.x | - | - ||
| | <1.18.9 | 1.18.9 - 1.18.13 | 1.19.8 |1.20.9|
|---------------------------|---------|------------------|--------|--------|
| SwiftkubeClient 0.6.x | - || - | - |
| SwiftkubeClient 0.7.x | - | - || - |
| SwiftkubeClient 0.8.x | - | - || - |
| SwiftkubeClient 0.9.x | - | - || - |
| SwiftkubeClient 0.10.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 client and Kubernetes have in common will work.
Expand Down Expand Up @@ -429,7 +430,7 @@ app.get("metrics") { request -> EventLoopFuture<String> in
To use the `SwiftkubeModel` 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.9.0"),
.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.10.0"),
```

then include it as a dependency in your target:
Expand All @@ -440,7 +441,7 @@ import PackageDescription
let package = Package(
// ...
dependencies: [
.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.9.0")
.package(name: "SwiftkubeClient", url: "https://github.com/swiftkube/client.git", from: "0.10.0")
],
targets: [
.target(name: "<your-target>", dependencies: [
Expand Down

0 comments on commit a90cdc0

Please sign in to comment.