Skip to content

Commit

Permalink
Swift 5.2 is now the minimum supported version. Update github org to …
Browse files Browse the repository at this point in the history
…Kitura (#57)

- Change github org from IBM-Swift to Kitura
  • Loading branch information
dannys42 authored Jun 30, 2022
1 parent 6372af4 commit bd42557
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 103 deletions.
6 changes: 2 additions & 4 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module: CircuitBreaker
author: IBM
github_url: https://github.com/IBM-Swift/CircuitBreaker
author: IBM & Kitura project authors
github_url: https://github.com/Kitura/CircuitBreaker

theme: fullwidth
clean: true
Expand All @@ -10,5 +10,3 @@ readme: README.md

skip_undocumented: false
hide_documentation_coverage: false

xcodebuild_arguments: [-project, CircuitBreaker.xcodeproj, -target, CircuitBreaker, LIBRARY_SEARCH_PATHS=.build/debug]
1 change: 0 additions & 1 deletion .swift-version

This file was deleted.

52 changes: 11 additions & 41 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,61 +12,31 @@ branches:
matrix:
include:
- os: linux
dist: xenial
dist: bionic
sudo: required
services: docker
env: DOCKER_IMAGE=swift:4.0.3 SWIFT_SNAPSHOT=4.0.3
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu18.04:5.2.5
- os: linux
dist: xenial
dist: focal
sudo: required
services: docker
env: DOCKER_IMAGE=swift:4.1.3 SWIFT_SNAPSHOT=4.1.3
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu20.04:5.4
- os: linux
dist: xenial
dist: focal
sudo: required
services: docker
env: DOCKER_IMAGE=swift:4.2.4 SWIFT_SNAPSHOT=4.2.4
- os: linux
dist: xenial
sudo: required
services: docker
env: DOCKER_IMAGE=swift:5.0.3-xenial SWIFT_SNAPSHOT=5.0.3
- os: linux
dist: xenial
sudo: required
services: docker
env: DOCKER_IMAGE=swift:5.1
- os: linux
dist: xenial
sudo: required
services: docker
env: DOCKER_IMAGE=swift:5.1 SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT
- os: osx
osx_image: xcode9.2
sudo: required
env: SWIFT_SNAPSHOT=4.0.3
- os: osx
osx_image: xcode9.4
sudo: required
env: SWIFT_SNAPSHOT=4.1.2
- os: osx
osx_image: xcode10.1
sudo: required
env: SWIFT_SNAPSHOT=4.2.1
- os: osx
osx_image: xcode10.2
sudo: required
env: SWIFT_SNAPSHOT=5.0.1 JAZZY_ELIGIBLE=true
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu20.04:latest USE_SWIFT_DEVELOPMENT_SNAPSHOT=1
- os: osx
osx_image: xcode11
osx_image: xcode12.2
sudo: required
env: JAZZY_ELIGIBLE=true
- os: osx
osx_image: xcode11
osx_image: xcode13.2
sudo: required
env: SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT
env: USE_SWIFT_DEVELOPMENT_SNAPSHOT=1

before_install:
- git clone https://github.com/IBM-Swift/Package-Builder.git
- git clone https://github.com/Kitura/Package-Builder.git

script:
- ./Package-Builder/build-package.sh -projectDir $TRAVIS_BUILD_DIR
2 changes: 1 addition & 1 deletion CircuitBreaker.podspec
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Pod::Spec.new do |s|
s.name = "CircuitBreaker"
s.version = "5.0.200"
s.version = "5.1.0"
s.summary = "A Swift Circuit Breaker library"
s.homepage = "https://github.com/Kitura/CircuitBreaker"
s.license = { :type => "Apache License, Version 2.0" }
Expand Down
4 changes: 2 additions & 2 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// swift-tools-version:5.0
// swift-tools-version:5.1
// The swift-tools-version declares the minimum version of Swift required to build this package.

/**
Expand Down Expand Up @@ -28,7 +28,7 @@ let package = Package(
)
],
dependencies: [
.package(url: "https://github.com/IBM-Swift/LoggerAPI.git", .upToNextMajor(from: "1.9.200"))
.package(url: "https://github.com/Kitura/LoggerAPI.git", .upToNextMajor(from: "1.9.200"))
],
targets: [
.target(
Expand Down
43 changes: 0 additions & 43 deletions [email protected]

This file was deleted.

20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<p align="center">
<a href="http://kitura.io/">
<img src="https://raw.githubusercontent.com/IBM-Swift/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
<img src="https://raw.githubusercontent.com/Kitura/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
</a>
</p>

<p align="center">
<a href="https://ibm-swift.github.io/CircuitBreaker/index.html">
<a href="https://kitura.github.io/CircuitBreaker/index.html">
<img src="https://img.shields.io/badge/apidoc-CircuitBreaker-1FBCE4.svg?style=flat" alt="APIDoc">
</a>
<a href="https://travis-ci.org/IBM-Swift/CircuitBreaker">
<img src="https://travis-ci.org/IBM-Swift/CircuitBreaker.svg?branch=master" alt="Build Status - Master">
<a href="https://travis-ci.org/Kitura/CircuitBreaker">
<img src="https://travis-ci.org/Kitura/CircuitBreaker.svg?branch=master" alt="Build Status - Master">
</a>
<img src="https://img.shields.io/badge/os-macOS-green.svg?style=flat" alt="macOS">
<img src="https://img.shields.io/badge/os-linux-green.svg?style=flat" alt="Linux">
Expand All @@ -25,14 +25,14 @@ The Circuit Breaker design pattern is used to increase application stability, im
![Circuit Breaker Diagram](resources/circuitBreakerDiagram.png)

## Swift version
The latest version of CircuitBreaker works with the `4.1.2` and newer version of the Swift binaries. You can download this version of the Swift binaries by following this [link](https://swift.org/download/#releases).
The latest version of CircuitBreaker works with the `5.1` and newer version of the Swift binaries. You can download this version of the Swift binaries by following this [link](https://swift.org/download/#releases).

## Getting Started

Add `CircuitBreaker` to the dependencies within your application's `Package.swift` file. Substitute `"x.x.x"` with the latest `CircuitBreaker` [release](https://github.com/IBM-Swift/CircuitBreaker/releases).
Add `CircuitBreaker` to the dependencies within your application's `Package.swift` file. Substitute `"x.x.x"` with the latest `CircuitBreaker` [release](https://github.com/Kitura/CircuitBreaker/releases).

```swift
.package(url: "https://github.com/IBM-Swift/CircuitBreaker.git", from: "x.x.x")
.package(url: "https://github.com/Kitura/CircuitBreaker.git", from: "x.x.x")
```
Add `CircuitBreaker` to your target's dependencies:

Expand Down Expand Up @@ -114,7 +114,7 @@ func myContextFunction(invocation: Invocation<(String), String>) {
}
```

- Create a CircuitBreaker instance for each context function (e.g. endpoint) you wish to circuit break. The CircuitBreaker instance must specify a name for the circuit breaker, the endpoint to circuit break and the fallback function. Optional configurations include: group, timeout, resetTimeout, maxFailures, rollingWindow and bulkhead, for further details about these configuration options see the [API reference](https://ibm-swift.github.io/CircuitBreaker/index.html).
- Create a CircuitBreaker instance for each context function (e.g. endpoint) you wish to circuit break. The CircuitBreaker instance must specify a name for the circuit breaker, the endpoint to circuit break and the fallback function. Optional configurations include: group, timeout, resetTimeout, maxFailures, rollingWindow and bulkhead, for further details about these configuration options see the [API reference](https://kitura.github.io/CircuitBreaker/index.html).

```swift
let breaker = CircuitBreaker(name: "Circuit1", command: myContextFunction, fallback: myFallback)
Expand Down Expand Up @@ -222,10 +222,10 @@ let snapshot = breaker.snapshot
The CircuitBreaker library provides an interface for observing new CircuitBreaker instances in order to register and track statistics changes. In the initialization of a CircuitBreaker instance, the linked monitors are notified of its instantiation allowing them to begin tracking the instance's statistics. The CircuitBreaker instance exposes a Hystrix compliant statistics snapshot to the monitor which can then be processed accordingly. See the API documentation for more information.

## API Documentation
For more information visit our [API reference](https://ibm-swift.github.io/CircuitBreaker/index.html).
For more information visit our [API reference](https://kitura.github.io/CircuitBreaker/index.html).

## Community
We love to talk server-side Swift, and Kitura. Join our [Slack](http://swift-at-ibm-slack.mybluemix.net/) to meet the team!

## License
This Swift package is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/IBM-Swift/CircuitBreaker/blob/master/LICENSE).
This Swift package is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/Kitura/CircuitBreaker/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion Sources/CircuitBreaker/CircuitBreaker.swift
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import LoggerAPI
/// ```
///
/// For a more complete example see the
/// [CircuitBreaker README](https://github.com/IBM-Swift/CircuitBreaker).
/// [CircuitBreaker README](https://github.com/Kitura/CircuitBreaker).
public class CircuitBreaker<A, B> {

// MARK: Closure Aliases
Expand Down

0 comments on commit bd42557

Please sign in to comment.