From 39716edd7108fd3bd4bc18edd451f027df2eb067 Mon Sep 17 00:00:00 2001 From: tyranron Date: Mon, 1 Feb 2021 16:58:02 +0200 Subject: [PATCH] Prepare 0.2.0-rc.1 release of 'medea' crate --- .github/workflows/ci.yml | 6 +++--- CHANGELOG.md | 9 +++++---- CONTRIBUTING.md | 11 ++--------- Cargo.lock | 21 +++++++++++++++++++-- Cargo.toml | 5 +++-- README.md | 15 ++++++++++++--- 6 files changed, 44 insertions(+), 23 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1a03506fe..61d762743 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -341,7 +341,7 @@ jobs: uses: actions-ecosystem/action-regex-match@v2 with: text: ${{ github.ref }} - regex: '^refs/tags/(medea-[a-z-]*)-([0-9]+\.[0-9]+\.[0-9]+-?.*)$' + regex: '^refs/tags/(medea[a-z-]*)-([0-9]+\.[0-9]+\.[0-9]+-?.*)$' - name: Verify release version matches Cargo manifest run: >- test "${{ steps.release.outputs.group2 }}" \ @@ -366,7 +366,7 @@ jobs: release-cargo: name: Release on crates.io needs: ['release-github'] - if: ${{ false }} + if: ${{ startsWith(github.ref, 'refs/tags/medea-') }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 @@ -375,7 +375,7 @@ jobs: uses: actions-ecosystem/action-regex-match@v2 with: text: ${{ github.ref }} - regex: '^refs/tags/(medea-[a-z-]*)-([0-9]+\.[0-9]+\.[0-9]+-?.*)$' + regex: '^refs/tags/(medea[a-z-]*)-([0-9]+\.[0-9]+\.[0-9]+-?.*)$' - uses: actions-rs/toolchain@v1 with: profile: minimal diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bd20a58b..122b2296a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,10 +6,10 @@ All user visible changes to this project will be documented in this file. This p -## TBD [0.2.0] · 2020-??-?? -[0.2.0]: /../../tree/medea-0.2.0 +## [0.2.0-rc.1] · 2021-02-01 +[0.2.0-rc.1]: /../../tree/medea-0.2.0-rc.1 -[Milestone](/../../milestone/2) | [Roadmap](/../../issues/27) +[Diff](/../../compare/medea-0.1.0...medea-0.2.0-rc.1) | [Milestone](/../../milestone/2) | [Roadmap](/../../issues/27) ### BC Breaks @@ -57,7 +57,7 @@ All user visible changes to this project will be documented in this file. This p - `[media]` section to configure timeouts involved for determining media flow liveness ([#98]): - `max_lag`; - `init_timeout`. - - `turn.db.redis.user` option to configure user to authenticate on [Coturn]'s Redis database server as ([#135]). + - `turn.db.redis.user` option to configure user to authenticate on [Coturn]'s [Redis] database server as ([#135]). - Testing: - E2E tests for signalling ([#28]). @@ -118,4 +118,5 @@ All user visible changes to this project will be documented in this file. This p [Coturn]: https://github.com/coturn/coturn +[Redis]: https://redis.io [Semantic Versioning 2.0.0]: https://semver.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7700d2ff..d256148b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,11 +6,9 @@ Contribution Guide ## Prerequisites -In addition to default stable [Rust] toolchain you will need [rustfmt] and [Clippy] components, and a nightly [Rust] toolchain (for better tooling). +In addition to default stable [Rust] toolchain you will a nightly [Rust] toolchain for [rustfmt]. ```bash $ rustup toolchain install nightly -$ rustup component add rustfmt -$ rustup component add clippy ``` Also, you need install [wasm-pack] for [Jason] building and testing: @@ -18,8 +16,6 @@ Also, you need install [wasm-pack] for [Jason] building and testing: $ curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sudo sh ``` -Also, you need install `protoc` if you want to rebuild [protobuf] specs for [Medea] gRPC Control API. - @@ -41,8 +37,6 @@ $ make up.medea ``` - - ### Building To build/rebuild project and its Docker image use docker-wrapped command from [`Makefile`]: @@ -123,14 +117,13 @@ $ make docs.rust crate=medea-jason ## CI integration -Add `[run ci]` mark to your commit message for triggering CI build. +Add `[skip ci]` mark to commit message to omit triggering a CI build. [`Makefile`]: Makefile -[Clippy]: https://github.com/rust-lang/rust-clippy [Jason]: https://github.com/instrumentisto/medea/tree/master/jason [Medea]: https://github.com/instrumentisto/medea [protobuf]: https://github.com/protocolbuffers/protobuf diff --git a/Cargo.lock b/Cargo.lock index e1624203e..976f0ac60 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1759,7 +1759,7 @@ checksum = "60302e4db3a61da70c0cb7991976248362f30319e88850c487b9b95bbf059e00" [[package]] name = "medea" -version = "0.2.0-dev" +version = "0.2.0-rc.1" dependencies = [ "actix", "actix-codec", @@ -1784,7 +1784,7 @@ dependencies = [ "lazy_static", "medea-client-api-proto 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)", "medea-control-api-proto 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", - "medea-coturn-telnet-client", + "medea-coturn-telnet-client 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", "medea-macro 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)", "mockall", "rand 0.8.3", @@ -1899,6 +1899,23 @@ dependencies = [ "tokio-util", ] +[[package]] +name = "medea-coturn-telnet-client" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5cad0c73b7523be968c728787697a8487b846b6c94c2b3ecebc01aa7ead7105" +dependencies = [ + "async-trait", + "bytes 0.5.6", + "deadpool", + "derive_more", + "futures 0.3.12", + "once_cell", + "regex", + "tokio", + "tokio-util", +] + [[package]] name = "medea-jason" version = "0.2.0-rc.1" diff --git a/Cargo.toml b/Cargo.toml index 0b0ed7e0f..da5690355 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "medea" -version = "0.2.0-dev" +version = "0.2.0-rc.1" edition = "2018" description = "Medea media server" authors = ["Instrumentisto Team "] @@ -68,7 +68,8 @@ toml = "0.5" tonic = "0.3" url = "2.1" [dependencies.medea-coturn-telnet-client] - path = "crates/medea-coturn-telnet-client" + version = "0.1" + #path = "crates/medea-coturn-telnet-client" features = ["pool"] [dependencies.slog] version = "2.5" diff --git a/README.md b/README.md index 1b6433221..7d6363eab 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,28 @@ Medea [![CI](https://github.com/instrumentisto/medea/workflows/CI/badge.svg?branch=master)](https://github.com/instrumentisto/medea/actions?query=workflow%3ACI+branch%3Amaster) [![Crates.io](https://img.shields.io/crates/v/medea)](https://crates.io/crates/medea) ![Crates.io license](https://img.shields.io/crates/l/medea) +[![Rust docs](https://docs.rs/medea/badge.svg)](https://docs.rs/medea) [Code Docs](https://docs.rs/medea) | [Changelog](https://github.com/instrumentisto/medea/blob/master/CHANGELOG.md) Medea media server. -__Currently, in early development phase.__ +Only implements [WebRTC] signalling at the moment. + +See [demo](https://github.com/instrumentisto/medea/blob/master/jason/demo) for an usage example. ## License -Copyright © 2019 Instrumentisto Team, https://github.com/instrumentisto +Copyright © 2019 Instrumentisto Team, + +This Source Code Form is subject to the terms of the [Mozilla Public License, v. 2.0](https://github.com/instrumentisto/medea/blob/master/LICENSE.md). If a copy of the MPL was not distributed with this file, You can obtain one at . + + + + -This Source Code Form is subject to the terms of the [Mozilla Public License, v. 2.0](https://github.com/instrumentisto/medea/blob/master/LICENSE.md). If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. +[WebRTC]: https://webrtc.org