This is an automated email from the ASF dual-hosted git repository. mgrigorov pushed a commit to branch branch-1.11 in repository https://gitbox.apache.org/repos/asf/avro.git
commit 81812a0b6c9426647b2827a02b7d33a5ba340480 Author: Martin Grigorov <[email protected]> AuthorDate: Wed Jan 5 07:48:08 2022 +0200 AVRO-3205 Rust: Update Cargo.toml [package] information (#1344) * AVRO-3205 Update Cargo.toml [package] information * AVRO-3205 Fix 'cargo doc` warning Documenting avro-rs v0.14.0 (/home/martin/git/apache/avro/lang/rust) warning: this URL is not a hyperlink --> src/lib.rs:696:5 | 696 | //! https://github.com/flavray/avro-rs/pull/76). | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/flavray/avro-rs/pull/76>` | = note: `#[warn(rustdoc::bare_urls)]` on by default = note: bare URLs are not automatically turned into clickable links * AVRO-3205 Add keywords and documentation to [package] * AVRO-3205 Add categories = ["encoding"] * AVRO-3205 Update markdown files Replace flavray/avro-rs with apache/avro. Replace MIT license with Apache License 2 (cherry picked from commit ea07ac016fef769e3e80645b32ca72e0a0d13a26) --- lang/rust/CHANGELOG.md | 5 ++++- lang/rust/Cargo.toml | 13 ++++++++----- lang/rust/README.md | 11 +++++------ lang/rust/README.tpl | 11 +++++------ lang/rust/src/lib.rs | 2 +- 5 files changed, 23 insertions(+), 19 deletions(-) diff --git a/lang/rust/CHANGELOG.md b/lang/rust/CHANGELOG.md index 0b1943a..47b959e 100644 --- a/lang/rust/CHANGELOG.md +++ b/lang/rust/CHANGELOG.md @@ -18,7 +18,10 @@ --> # Changelog -All notable changes to this project will be documented in this file. + +This file has been used by [avro-rs](https://github.com/flavray/avro-rs) before donating the project to Apache Avro. +Apache Avro uses [JIRA](https://issues.apache.org/jira/browse/AVRO) for issue tracking and changelog! + The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). diff --git a/lang/rust/Cargo.toml b/lang/rust/Cargo.toml index d0be3d0..d82e5ff 100644 --- a/lang/rust/Cargo.toml +++ b/lang/rust/Cargo.toml @@ -17,13 +17,16 @@ [package] name = "avro-rs" -version = "0.13.0" -authors = ["Flavien Raynaud <[email protected]>", "Antonio Verardi <[email protected]>"] -description = "Library for working with Apache Avro in Rust" -license = "MIT" +version = "0.14.0" +authors = ["Apache Avro team <[email protected]>"] +description = "A library for working with Apache Avro in Rust" +license = "Apache-2.0" readme = "README.md" -repository = "https://github.com/flavray/avro-rs"; +repository = "https://github.com/apache/avro"; edition = "2018" +keywords = ["avro", "data", "serialization"] +categories = ["encoding"] +documentation = "https://docs.rs/avro-rs"; [features] snappy = ["crc", "snap"] diff --git a/lang/rust/README.md b/lang/rust/README.md index 7ac542a..e934cc3 100644 --- a/lang/rust/README.md +++ b/lang/rust/README.md @@ -20,9 +20,9 @@ # avro-rs [](https://crates.io/crates/avro-rs) -[](https://github.com/flavray/avro-rs/actions) +[](https://github.com/apache/avro/actions/workflows/test-lang-rust-ci.yml) [](https://docs.rs/avro-rs) -[](https://github.com/flavray/avro-rs/blob/main/LICENSE) +[ A library for working with [Apache Avro](https://avro.apache.org/) in Rust. @@ -614,13 +614,12 @@ assert_eq!(false, SchemaCompatibility::can_read(&writers_schema, &readers_schema ``` ## License -This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). -Please note that this is not an official project maintained by [Apache Avro](https://avro.apache.org/). +This project is licensed under [Apache License 2.0](https://github.com/apache/avro/blob/master/LICENSE.txt). ## Contributing Everyone is encouraged to contribute! You can contribute by forking the GitHub repo and making a pull request or opening an issue. -All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). +All contributions will be licensed under [Apache License 2.0](https://github.com/apache/avro/blob/master/LICENSE.txt). -Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/main/CHANGELOG.md). +Please consider adding documentation and tests! If you introduce a backward-incompatible change, please consider adding instruction to migrate in the [Migration Guide](migration_guide.md) If you modify the crate documentation in `lib.rs`, run `make readme` to sync the README file. diff --git a/lang/rust/README.tpl b/lang/rust/README.tpl index daab35c..88830d1 100644 --- a/lang/rust/README.tpl +++ b/lang/rust/README.tpl @@ -1,20 +1,19 @@ # {{crate}} [](https://crates.io/crates/avro-rs) -[](https://github.com/flavray/avro-rs/actions) +[](https://github.com/apache/avro/actions/workflows/test-lang-rust-ci.yml) [](https://docs.rs/avro-rs) -[](https://github.com/flavray/avro-rs/blob/main/LICENSE) +[ {{readme}} ## License -This project is licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). -Please note that this is not an official project maintained by [Apache Avro](https://avro.apache.org/). +This project is licensed under [Apache License 2.0](https://github.com/apache/avro/blob/master/LICENSE.txt). ## Contributing Everyone is encouraged to contribute! You can contribute by forking the GitHub repo and making a pull request or opening an issue. -All contributions will be licensed under [MIT License](https://github.com/flavray/avro-rs/blob/main/LICENSE). +All contributions will be licensed under [Apache License 2.0](https://github.com/apache/avro/blob/master/LICENSE.txt). -Please consider adding documentation, tests and a line for your change under the Unreleased section in the [CHANGELOG](https://github.com/flavray/avro-rs/blob/main/CHANGELOG.md). +Please consider adding documentation and tests! If you introduce a backward-incompatible change, please consider adding instruction to migrate in the [Migration Guide](migration_guide.md) If you modify the crate documentation in `lib.rs`, run `make readme` to sync the README file. diff --git a/lang/rust/src/lib.rs b/lang/rust/src/lib.rs index 21530d9..ca14939 100644 --- a/lang/rust/src/lib.rs +++ b/lang/rust/src/lib.rs @@ -693,7 +693,7 @@ //! This library supports checking for schemas compatibility. //! //! Note: It does not yet support named schemas (more on -//! https://github.com/flavray/avro-rs/pull/76). +//! <https://github.com/flavray/avro-rs/pull/76>). //! //! Examples of checking for compatibility: //!
