Release 0.2.0 - wss/tls support

rerun-io · Apr 8, 2022 · f6a0896 · f6a0896
1 parent d7b08ae
commit f6a0896
Show file tree

Hide file tree

Showing 8 changed files with 619 additions and 602 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+## Unreleased
+
+## 0.2.0 - 2022-04-08
+* Support WSS (WebSocket Secure) / TLS
+* Improve error reporting
+* `EventHandler` no longer needs to be `Sync`
+
+## 0.1.0 - 2022-02-23
+Initial commit: a simple WebSocket client library that works on both native and on the web.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,9 +1,6 @@
 [workspace]
 resolver = "2"
-members = [
-    "ewebsock",
-    "example_app",
-]
+members = ["ewebsock", "example_app"]
 
 [patch.crates-io]
 # If you want to use the bleeding edge version of egui/eframe:

diff --git a/check.sh b/check.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # This scripts runs various CI-like checks in a convenient way.
 set -eux
 

diff --git a/docs/example_app.js b/docs/example_app.js
diff --git a/docs/example_app_bg.wasm b/docs/example_app_bg.wasm
diff --git a/ewebsock/Cargo.toml b/ewebsock/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ewebsock"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["Emil Ernerfeldt <emil.ernerfeldt@gmail.com>"]
 description = "WebSocket client that works natively and on the web (WASM)"
 edition = "2021"
@@ -11,17 +11,19 @@ homepage = "https://github.com/rerun-io/ewebsock"
 repository = "https://github.com/rerun-io/ewebsock"
 categories = ["web-programming", "wasm"]
 keywords = ["websocket", "websockets", "portable", "native", "web"]
-include = [
-  "../LICENSE-APACHE",
-  "../LICENSE-MIT",
-  "**/*.rs",
-  "Cargo.toml",
-]
+include = ["../LICENSE-APACHE", "../LICENSE-MIT", "**/*.rs", "Cargo.toml"]
 
 [features]
 default = ["with_tungstenite"]
 tls = ["tokio-tungstenite/rustls-tls-webpki-roots"]
-with_tungstenite = ["async-stream", "futures", "futures-util", "tokio", "tokio-tungstenite", "tungstenite"]
+with_tungstenite = [
+  "async-stream",
+  "futures-util",
+  "futures",
+  "tokio-tungstenite",
+  "tokio",
+  "tungstenite",
+]
 
 [dependencies]
 tracing = "0.1"
@@ -34,7 +36,10 @@ tracing = "0.1"
 # Feature "tungstenite":
 async-stream = { version = "0.3", optional = true }
 futures = { version = "0.3", optional = true }
-futures-util = { version = "0.3", default-features = false, features = ["sink", "std"], optional = true }
+futures-util = { version = "0.3", default-features = false, features = [
+  "sink",
+  "std",
+], optional = true }
 tokio = { version = "1.16", features = ["rt", "sync"], optional = true }
 tokio-tungstenite = { version = "0.17", optional = true }
 tungstenite = { version = "0.17", optional = true }

diff --git a/example_app/Cargo.toml b/example_app/Cargo.toml
@@ -5,12 +5,7 @@ authors = ["Emil Ernerfeldt <emil.ernerfeldt@gmail.com>"]
 edition = "2021"
 rust-version = "1.56"
 license = "MIT OR Apache-2.0"
-include = [
-  "../LICENSE-APACHE",
-  "../LICENSE-MIT",
-  "**/*.rs",
-  "Cargo.toml",
-]
+include = ["../LICENSE-APACHE", "../LICENSE-MIT", "**/*.rs", "Cargo.toml"]
 
 
 [lib]

diff --git a/release_checklist.md b/release_checklist.md
@@ -0,0 +1,11 @@
+- [ ] Update `CHANGELOG.md`
+- [ ] Bump version number
+- [ ] `./check.sh`
+- [ ] `./example_app/build_web.sh --open`
+- [ ] `git commit -m 'Release 0.x.0 - summary'`
+- [ ] `(cd ewebsock && cargo publish)`
+- [ ] `git tag -a 0.x.0 -m 'Release 0.x.0 - summary'`
+- [ ] `git push && git push --tags`
+- [ ] Check that CI is green
+- [ ] Do a GitHub release: https://github.com/emilk/rerun-io/ewebsock/new
+- [ ] Post on Twitter