This is an automated email from the ASF dual-hosted git repository. mgrigorov pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/avro-rs.git
commit 070c83adb58c6a28a134b9d0659c5a2ee2581082 Author: Martin Tzvetanov Grigorov <[email protected]> AuthorDate: Mon Oct 7 10:06:11 2024 +0300 chore: Add CI badges to the README.md Signed-off-by: Martin Tzvetanov Grigorov <[email protected]> --- avro/README.md | 21 ++++++++++++++++++++- avro/src/lib.rs | 21 ++++++++++++++++++++- 2 files changed, 40 insertions(+), 2 deletions(-) diff --git a/avro/README.md b/avro/README.md index 986dd31..2244ef8 100644 --- a/avro/README.md +++ b/avro/README.md @@ -26,6 +26,21 @@ <!-- cargo-rdme start --> +[![rust continuous integration][rust continuous integration img]][rust continuous integration] +[![rust clippy check][rust clippy check img]][rust clippy check] +[![rust security audit][rust security audit img]][rust security audit] +[![rust continuous integration ARM64][rust continuous integration ARM64 img]][rust continuous integration ARM64] + +[rust continuous integration]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci.yml +[rust continuous integration ARM64]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci-ARM.yml +[rust clippy check]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-clippy.yml +[rust security audit]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-audit.yml + +[rust continuous integration img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci.yml/badge.svg +[rust clippy check img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-clippy.yml/badge.svg +[rust security audit img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-audit.yml/badge.svg +[rust continuous integration ARM64 img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci-ARM.yml/badge.svg + A library for working with [Apache Avro](https://avro.apache.org/) in Rust. Please check our [documentation](https://docs.rs/apache-avro) for examples, tutorials and API reference. @@ -99,7 +114,11 @@ features = ["xz"] ## Upgrading to a newer minor version The library is still in beta, so there might be backward-incompatible changes between minor -versions. If you have troubles upgrading, check the [version upgrade guide](https://github.com/apache/avro/blob/main/lang/rust/migration_guide.md). +versions. If you have troubles upgrading, check the release notes. + +## Minimum supported Rust version + +1.73.0 ## Defining a schema diff --git a/avro/src/lib.rs b/avro/src/lib.rs index b05d198..c35f672 100644 --- a/avro/src/lib.rs +++ b/avro/src/lib.rs @@ -15,6 +15,21 @@ // specific language governing permissions and limitations // under the License. +//! [![rust continuous integration][rust continuous integration img]][rust continuous integration] +//! [![rust clippy check][rust clippy check img]][rust clippy check] +//! [![rust security audit][rust security audit img]][rust security audit] +//! [![rust continuous integration ARM64][rust continuous integration ARM64 img]][rust continuous integration ARM64] +//! +//! [rust continuous integration]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci.yml +//! [rust continuous integration ARM64]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci-ARM.yml +//! [rust clippy check]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-clippy.yml +//! [rust security audit]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-audit.yml +//! +//! [rust continuous integration img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci.yml/badge.svg +//! [rust clippy check img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-clippy.yml/badge.svg +//! [rust security audit img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-audit.yml/badge.svg +//! [rust continuous integration ARM64 img]: https://github.com/apache/avro-rs/actions/workflows/test-lang-rust-ci-ARM.yml/badge.svg +//! //! A library for working with [Apache Avro](https://avro.apache.org/) in Rust. //! //! Please check our [documentation](https://docs.rs/apache-avro) for examples, tutorials and API reference. @@ -88,7 +103,11 @@ //! # Upgrading to a newer minor version //! //! The library is still in beta, so there might be backward-incompatible changes between minor -//! versions. If you have troubles upgrading, check the [version upgrade guide](https://github.com/apache/avro/blob/main/lang/rust/migration_guide.md). +//! versions. If you have troubles upgrading, check the release notes. +//! +//! # Minimum supported Rust version +//! +//! 1.73.0 //! //! # Defining a schema //!
