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

Commit 09ad009

Browse files
committed
Update README
Add instructions for how to upgrade to a new Swift version
1 parent 0901119 commit 09ad009

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

.swift-version

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

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

101+
### Upgrading to a new Swift version
102+
103+
Upgrading a new Swift version requires upgrading the dependencies as well. Since the RxWebSocket is
104+
distributed through Cocoapods, Carthage and Swift Package Manager, the dependencies must be upgraded
105+
in the corresponding spec file for the three platforms:
106+
107+
#### Cocoapods
108+
109+
In RxWebSocket.podspec, update `swift_version` and the dependencies' versions at the end of the file
110+
111+
#### Carthage
112+
113+
Upgrade the dependencies' versions in `Cartfile`
114+
115+
#### Swift Package Manager
116+
117+
Upgrade the dependencies' versions in `Package.swift`
118+
119+
### Housekeeping
120+
121+
Before commiting, make sure to run, at least, the `test` lane on Fastlane. This will run all iOS
122+
tests.
123+
124+
If you want to be thorough, which is recommended and appreciated, run the `ci` lane, which is the
125+
same lane Travis runs when testing PRs. This lane will run tests for iOS, tvOS and macOS, as well as
126+
lint the project for the three package managers. If this lane passes, you can be 100% sure everything
127+
is running as smoothly as possible.
128+
101129
## Help Wanted
102130

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

0 commit comments

Comments
 (0)