From db42fdc1c7a112923c69d82dd712af9febf63de2 Mon Sep 17 00:00:00 2001 From: gudaoxuri Date: Mon, 23 Oct 2023 02:50:59 +0000 Subject: [PATCH] Dependency Updates. --- CHANGELOG.adoc | 35 ---------------------------- CONTRIBUTING.adoc => CONTRIBUTING.md | 11 ++++----- Cargo.toml | 2 +- README.md | 13 ++++------- tardis/Cargo.toml | 20 ++++++++-------- tardis/README.md | 18 ++++++++------ 6 files changed, 31 insertions(+), 68 deletions(-) delete mode 100644 CHANGELOG.adoc rename CONTRIBUTING.adoc => CONTRIBUTING.md (85%) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc deleted file mode 100644 index 72ecb459..00000000 --- a/CHANGELOG.adoc +++ /dev/null @@ -1,35 +0,0 @@ -== Versions - -=== Channel description - -[IMPORTANT] -==== -There are several version types of ``Tardis``, so please choose carefully when using them. - -. ``ga`` General Availability, the official version, internally tested with no known bugs and verified in production, preferred for production environments! -. . ``rc`` Release Candidate, internally tested with no known bugs and available for production environments. -. ``beta`` Public Beta, no known major type of bugs, but minor type of bugs are allowed, production use requires careful evaluation! -. ``alpha`` Internal test version, very early test version, not internally tested, may have more Bugs, this version is similar to Technical Preview, must *not* be used in production environment! -. ``snapshot`` snapshot version, similar to Nightly version, frequent updates, no quality assurance, do *not* use for production environment! - -==== - -TIP: The version number follows the https://semver.org/[``semver``] specification. - -=== Release Notes - -==== 0.1.0(WIP) - -Initial release - -.Features -* Relational database client for MySQL, PostgresSQL -* Web service and web client for OpenAPI v3.x -* Distributed cache client for Redis protocol -* RabbitMQ client for AMQP protocol -* Mainstream encryption algorithms and SM2/3/4 algorithms -* Containerized unit testing of mainstream middleware -* Multi-environment configuration -* Commonly used operations (E.g. uniform error handling, encryption and decryption, regular checksums) - - diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.md similarity index 85% rename from CONTRIBUTING.adoc rename to CONTRIBUTING.md index 1b0a8a72..e6007943 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -== Contributing +## Contributing The Tardis project has just started. Due to personal capacity and energy constraints, the project still has a lot of features to improve. If you are interested in Rust and want to build a lightweight Rust development framework, you are welcome to participate in building it together. You can. @@ -8,20 +8,19 @@ are interested in Rust and want to build a lightweight Rust development framewor 3. add documentation and examples 4. provide some good ideas -=== Development Environment Requirements +### Development Environment Requirements 1. stable channel of Rust distribution 2. local Docker execution environment -=== Code Commit Requirements +### Code Commit Requirements Before committing, make sure your code can pass automated checks. -[source,bash] ----- +```rust cargo fmt --all --check cargo clippy --all-features ----- +``` Thanks. diff --git a/Cargo.toml b/Cargo.toml index 7f1cc215..17b00f06 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ codegen-units = 1 opt-level = "z" [workspace.package] -version = "0.1.0-beta.12" +version = "0.1.0-rc.1" authors = ["gudaoxuri "] description = "Elegant, clean Rust development framework" keywords = ["http", "database", "web", "redis", "mq"] diff --git a/README.md b/README.md index 7861a1d3..4bd9a8fd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,3 @@ -**Preview version, will not guarantee the stability of the API! -Do NOT use in production environment!** - --- **Elegant, Clean Rust development framework🛸** @@ -32,9 +29,7 @@ Do NOT use in production environment!** ## 📦 Components -| Crate | Description | -|-------------------------------|-------------| -| **tardis** [![Crate](https://img.shields.io/crates/v/tardis.svg)](https://crates.io/crates/tardis) [![Docs](https://docs.rs/tardis/badge.svg)](https://docs.rs/tardis) | [README](./tardis/README.md) | -| **tardis-macros** [![Crate](https://img.shields.io/crates/v/tardis-macros.svg)](https://crates.io/crates/tardis) [![Docs](https://docs.rs/tardis-macros/badge.svg)](https://docs.rs/tardis) | | - - +| Crate | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | +| **tardis** [![Crate](https://img.shields.io/crates/v/tardis.svg)](https://crates.io/crates/tardis) [![Docs](https://docs.rs/tardis/badge.svg)](https://docs.rs/tardis) | [README](./tardis/README.md) | +| **tardis-macros** [![Crate](https://img.shields.io/crates/v/tardis-macros.svg)](https://crates.io/crates/tardis) [![Docs](https://docs.rs/tardis-macros/badge.svg)](https://docs.rs/tardis) | | diff --git a/tardis/Cargo.toml b/tardis/Cargo.toml index 78d5b2e6..2d8dfe67 100644 --- a/tardis/Cargo.toml +++ b/tardis/Cargo.toml @@ -72,8 +72,8 @@ chrono = { version = "0.4", features = ["serde"] } config = { version = "0.13" } regex = { version = "1.5" } url = { version = "2.2", features = ["serde"] } -lru = { version = "0.11.0" } -typed-builder = { version = "0.16" } +lru = { version = "0.12.0" } +typed-builder = { version = "0.18" } paste = { version = "1.0" } # Tokio tokio = { version = "1", features = [ @@ -84,12 +84,12 @@ tokio = { version = "1", features = [ "sync", ] } # Tardis Macros -tardis-macros = { version = "0.1.0-beta.11", path = "../tardis-macros", optional = true } +tardis-macros = { version = "0.1.0-rc.1", path = "../tardis-macros", optional = true } # Log tracing = { version = "0.1" } tracing-subscriber = { version = "0.3", features = ["env-filter"] } tracing-appender = { version = "0.2", optional = true } -console-subscriber = { version = "0.1", optional = true } +console-subscriber = { version = "0.2", optional = true } # Tracing tracing-opentelemetry = { version = "0.21", optional = true } opentelemetry = { version = "0.20", default-features = false, features = [ @@ -180,7 +180,7 @@ redis = { version = "0.23", features = [ "tokio-comp", "tokio-native-tls-comp", ], optional = true } -deadpool-redis = { version = "0.12", optional = true } +deadpool-redis = { version = "0.13", optional = true } # Rabbit lapin = { version = "2", optional = true } @@ -188,7 +188,7 @@ amq-protocol-types = { version = "7.0", optional = true } async-global-executor = { version = "2", features = ["tokio"], optional = true } # Mail -lettre = { version = "0.10.4", features = [ +lettre = { version = "0.11", features = [ "smtp-transport", "tokio1", "tokio1-native-tls", @@ -200,18 +200,18 @@ rust-s3 = { version = "0.33", optional = true } anyhow = { version = "1.0", optional = true } # K8s -kube = { version = "0.85", features = ["runtime"], optional = true } -k8s-openapi = { version = "0.19", features = ["v1_21"], optional = true } +kube = { version = "0.88", features = ["runtime"], optional = true } +k8s-openapi = { version = "0.20", features = ["v1_21"], optional = true } # Test -testcontainers = { version = "0.14", optional = true } +testcontainers = { version = "0.15", optional = true } [dev-dependencies] # Common tokio = { version = "1", features = ["time", "rt", "macros", "sync"] } criterion = { version = "0.5" } poem-grpc-build = "0.2.21" -prost = "0.11.9" +prost = "0.12" strip-ansi-escapes = "0.2.0" [[test]] diff --git a/tardis/README.md b/tardis/README.md index 6fa97df0..81559e8c 100644 --- a/tardis/README.md +++ b/tardis/README.md @@ -1,6 +1,3 @@ -**Preview version, will not guarantee the stability of the API! -Do NOT use in production environment!** - --- **Elegant, Clean Rust development framework🛸** @@ -73,12 +70,14 @@ TardisFuns::web_server().x // Some web service operations ### Web service example Dependency Configuration + ```toml [dependencies] tardis = { version = "^0", features = ["web-server"] } ``` Processor Configuration + ```ignore use tardis::basic::error::TardisError; use tardis::web::poem_openapi; @@ -100,6 +99,7 @@ impl Api { ``` Startup class configuration + ```ignore use tardis::basic::result::TardisResult; use tardis::tokio; @@ -168,7 +168,8 @@ brew install protobuf ### FAQ -* An `` failed to run custom build command for openssl-sys`` error occurs when running under Windows.The solution is as follows( @see https://github.com/sfackler/rust-openssl/issues/1062 ): +* An `` failed to run custom build command for openssl-sys`` error occurs when running under Windows.The solution is as follows( @see https://github.com/sfackler/rust-openssl/issues/1062 ): + ```shell git clone https://github.com/Microsoft/vcpkg --depth=1 cd vcpkg @@ -178,12 +179,13 @@ brew install protobuf set OPENSSL_NO_VENDOR=1 set OPENSSL_DIR=\packages\openssl_x64-windows-static ``` - * An `` failed to run custom build command for openssl-sys`` error occurs when running under Ubuntu(similar to other distributions): + ```shell apt install build-essential perl pkg-config libssl-dev ``` * FreeBSD deployment for ``openssl-sys`` + ```shell sudo pkg install cmake ninja zip pkgconf gmake git clone https://github.com/Microsoft/vcpkg --depth=1 @@ -193,14 +195,16 @@ brew install protobuf ./vcpkg install openssl ``` * An `` failed to run custom build command for opentelemetry-proto`` error occurs when running under Linux: + ```shell apt install protobuf-compiler ``` * An `` failed to run custom build command for opentelemetry-proto`` error occurs when running under MacOS: + ```shell brew install protobuf ``` ----- -Thanks to `Jetbrains` for the [Open Source License](https://www.jetbrains.com/community/opensource/) +--- +Thanks to `Jetbrains` for the [Open Source License](https://www.jetbrains.com/community/opensource/)