Skip to content
This repository has been archived by the owner on Aug 1, 2023. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Add instructions for how to upgrade to a new Swift version
  • Loading branch information
fjcaetano committed Jun 27, 2019
1 parent 0901119 commit 09ad009
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
1 change: 0 additions & 1 deletion .swift-version

This file was deleted.

28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,34 @@ sign that the server is not running. If so, you can manage it running
This will tell wstests to launch an echo server on 127.0.0.1:9000. If this port
is unusable for you by any reason, you may change it in the `server.sh` file.

### Upgrading to a new Swift version

Upgrading a new Swift version requires upgrading the dependencies as well. Since the RxWebSocket is
distributed through Cocoapods, Carthage and Swift Package Manager, the dependencies must be upgraded
in the corresponding spec file for the three platforms:

#### Cocoapods

In RxWebSocket.podspec, update `swift_version` and the dependencies' versions at the end of the file

#### Carthage

Upgrade the dependencies' versions in `Cartfile`

#### Swift Package Manager

Upgrade the dependencies' versions in `Package.swift`

### Housekeeping

Before commiting, make sure to run, at least, the `test` lane on Fastlane. This will run all iOS
tests.

If you want to be thorough, which is recommended and appreciated, run the `ci` lane, which is the
same lane Travis runs when testing PRs. This lane will run tests for iOS, tvOS and macOS, as well as
lint the project for the three package managers. If this lane passes, you can be 100% sure everything
is running as smoothly as possible.

## Help Wanted

Do you love RxWebsocket and work actively on apps that use it? We'd love if you could help us keep improving it!
Expand Down

0 comments on commit 09ad009

Please sign in to comment.