From 7c2aea93b5ec4145c827672719a9bc6f61c80ab0 Mon Sep 17 00:00:00 2001 From: Rain Date: Sat, 29 Jan 2022 10:43:19 -0800 Subject: [PATCH] =?UTF-8?q?[quick-junit]=20in=20the=20readme,=20replace=20?= =?UTF-8?q?markdown=20checkboxes=20with=20=E2=9C=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Makes them render properly on crates.io. --- Cargo.lock | 2 +- quick-junit/CHANGELOG.md | 6 ++++++ quick-junit/Cargo.toml | 2 +- quick-junit/README.md | 14 +++++++------- quick-junit/src/lib.rs | 14 +++++++------- 5 files changed, 22 insertions(+), 16 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index b36cdaff4..fd21886f2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -922,7 +922,7 @@ checksum = "a993555f31e5a609f617c12db6250dedcac1b0a85076912c436e6fc9b2c8e6a3" [[package]] name = "quick-junit" -version = "0.1.2" +version = "0.1.3" dependencies = [ "chrono", "goldenfile", diff --git a/quick-junit/CHANGELOG.md b/quick-junit/CHANGELOG.md index eb08eb355..d3a3b8006 100644 --- a/quick-junit/CHANGELOG.md +++ b/quick-junit/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## [0.1.3] - 2022-01-29 + +- In the readme, replace Markdown checkboxes with Unicode ✅ to make them render properly on + crates.io. + ## [0.1.2] - 2022-01-29 - Expand readme. @@ -13,6 +18,7 @@ - Initial version. +[0.1.3]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.3 [0.1.2]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.2 [0.1.1]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.1 [0.1.0]: https://github.com/diem/diem-devtools/releases/tag/quick-junit-0.1.0 diff --git a/quick-junit/Cargo.toml b/quick-junit/Cargo.toml index fb9e255d3..76253fea8 100644 --- a/quick-junit/Cargo.toml +++ b/quick-junit/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "quick-junit" description = "Data model and serializer for JUnit/XUnit XML" -version = "0.1.2" +version = "0.1.3" authors = ["Diem Association "] readme = "README.md" license = "Apache-2.0 OR MIT" diff --git a/quick-junit/README.md b/quick-junit/README.md index c7883d9d5..e49c7cca0 100644 --- a/quick-junit/README.md +++ b/quick-junit/README.md @@ -21,15 +21,15 @@ The status (success, failure, error, or skipped) of a `TestCase` is represented ## Features -- x Serializing JUnit/XUnit to the [Jenkins format](https://llg.cubic.org/docs/junit/). -- x Including test reruns using `TestRerun` -- x Including flaky tests -- x Including standard output and error - - x Filtering out [invalid XML +- ✅ Serializing JUnit/XUnit to the [Jenkins format](https://llg.cubic.org/docs/junit/). +- ✅ Including test reruns using `TestRerun` +- ✅ Including flaky tests +- ✅ Including standard output and error + - ✅ Filtering out [invalid XML characters](https://en.wikipedia.org/wiki/Valid_characters_in_XML) (eg ANSI escape codes) from the output -- x Automatically keeping track of success, failure and error counts -- x Arbitrary properties and extra attributes +- ✅ Automatically keeping track of success, failure and error counts +- ✅ Arbitrary properties and extra attributes This crate does not currently support deserializing JUnit XML. (PRs are welcome!) diff --git a/quick-junit/src/lib.rs b/quick-junit/src/lib.rs index 12be8262b..a37cf3962 100644 --- a/quick-junit/src/lib.rs +++ b/quick-junit/src/lib.rs @@ -17,15 +17,15 @@ //! //! # Features //! -//! - [x] Serializing JUnit/XUnit to the [Jenkins format](https://llg.cubic.org/docs/junit/). -//! - [x] Including test reruns using [`TestRerun`] -//! - [x] Including flaky tests -//! - [x] Including standard output and error -//! - [x] Filtering out [invalid XML +//! - ✅ Serializing JUnit/XUnit to the [Jenkins format](https://llg.cubic.org/docs/junit/). +//! - ✅ Including test reruns using [`TestRerun`] +//! - ✅ Including flaky tests +//! - ✅ Including standard output and error +//! - ✅ Filtering out [invalid XML //! characters](https://en.wikipedia.org/wiki/Valid_characters_in_XML) (eg ANSI escape codes) //! from the output -//! - [x] Automatically keeping track of success, failure and error counts -//! - [x] Arbitrary properties and extra attributes +//! - ✅ Automatically keeping track of success, failure and error counts +//! - ✅ Arbitrary properties and extra attributes //! //! This crate does not currently support deserializing JUnit XML. (PRs are welcome!) //!