From 339caed26a8f9f7744f3621fc11987577002e158 Mon Sep 17 00:00:00 2001 From: Charlotte Date: Tue, 3 Oct 2023 17:08:50 +1100 Subject: [PATCH] 0.19.0 --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 15 ++++++++------- changelog.txt | 27 +++++++++++++++++++++++++++ 4 files changed, 37 insertions(+), 9 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index b65fa393..7fea05c9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -126,7 +126,7 @@ dependencies = [ [[package]] name = "comrak" -version = "0.18.0" +version = "0.19.0" dependencies = [ "arbitrary", "clap", diff --git a/Cargo.toml b/Cargo.toml index dfe01373..ab1bb0c2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "comrak" -version = "0.18.0" +version = "0.19.0" authors = ["Asherah Connor "] description = "A 100% CommonMark-compatible GitHub Flavored Markdown parser and formatter" documentation = "https://docs.rs/comrak" diff --git a/README.md b/README.md index 7f335d91..f2b60739 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Specify it as a requirement in `Cargo.toml`: ``` toml [dependencies] -comrak = "0.18" +comrak = "0.19" ``` Comrak supports Rust stable. @@ -202,19 +202,22 @@ assert_eq!( For running benchmarks, you will need to [install hyperfine](https://github.com/sharkdp/hyperfine#installation) and optionally cmake. If you want to just run the benchmark for `comrak`, with the current state of the repo, you can simply run -```bash + +``` bash make bench-comrak ``` This will build comrak in release mode, and run benchmark on it. You will see the time measurements as reported by hyperfine in the console. Makefile also provides a way to run benchmarks for `comrak` current state (with your changes), `comrak` main branch, [`cmark-gfm`](https://github.com/github/cmark-gfm), [`pulldown-cmark`](https://github.com/raphlinus/pulldown-cmark) and [`markdown-it.rs`](https://github.com/rlidwka/markdown-it.rs). For this you will need to install `cmake`. After that make sure that you have set-up the git submodules. In case you have not installed submodules when cloning, you can do it by running -```bash + +``` bash git submodule update --init ``` -After this is done, you can run -```bash +After this is done, you can run + +``` bash make bench-all ``` @@ -222,8 +225,6 @@ which will run benchmarks across all, and report the time take by each as well a Apart from this, CI is also setup for running benchmarks when a pull request is first opened. It will add a comment with the results on the pull request in a tabular format comparing the 5 versions. After that you can manually trigger this CI by commenting `/run-bench` on the PR, this will update the existing comment with new results. Note benchmarks won't be automatically run on each push. - - ## Security As with [`cmark`](https://github.com/commonmark/cmark) and [`cmark-gfm`](https://github.com/github/cmark-gfm#security), diff --git a/changelog.txt b/changelog.txt index 74e2fcec..298f078d 100644 --- a/changelog.txt +++ b/changelog.txt @@ -1,3 +1,30 @@ +### 0.19.0 + +* Simplify anchorize() by @kornelski in https://github.com/kivikakk/comrak/pull/297 +* Use footnote name for reference id by @digitalmoksha in https://github.com/kivikakk/comrak/pull/300 +* Escape footnote name by @digitalmoksha in https://github.com/kivikakk/comrak/pull/308 +* Add in-doc labels for public facing features by @CosmicHorrorDev in https://github.com/kivikakk/comrak/pull/304 +* build(deps): bump xml-rs from 0.8.4 to 0.8.14 by @dependabot in https://github.com/kivikakk/comrak/pull/312 +* Handle footnote names that have been parsed into multiple nodes by @digitalmoksha in https://github.com/kivikakk/comrak/pull/311 +* Sync with cmark-gfm-0.29.0.gfm.3 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/313 +* Sync with cmark-gfm-0.29.0.gfm.4 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/314 +* Sync with cmark-gfm-0.29.0.gfm.5 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/315 +* Fix backslash in a link issue by @vpetrigo in https://github.com/kivikakk/comrak/pull/317 +* Sync with cmark-gfm-0.29.0.gfm.7 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/318 +* Rename `ComrakFoo` types to just `Foo` for easier usage by @tgross35 in https://github.com/kivikakk/comrak/pull/320 +* Make `ComrakExtensionOptions` non-exhaustive by @CosmicHorrorDev in https://github.com/kivikakk/comrak/pull/305 +* Add builder derive and non_exhaustive for option structs by @YJDoc2 in https://github.com/kivikakk/comrak/pull/292 +* add PartialEq and Eq derive for Ast and its components by @YJDoc2 in https://github.com/kivikakk/comrak/pull/322 +* Sync with cmark-gfm-0.29.0.gfm.11 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/319 +* Fix autolink detection inside wiki style link brackets by @digitalmoksha in https://github.com/kivikakk/comrak/pull/325 +* Add CI for running benchmarks by @YJDoc2 in https://github.com/kivikakk/comrak/pull/326 +* Make adapters Send + Sync by @lucperkins in https://github.com/kivikakk/comrak/pull/337 +* docs: fix-up broken docs.rs link by @silverjam in https://github.com/kivikakk/comrak/pull/341 +* Use github/cmark-gfm submodule by @digitalmoksha in https://github.com/kivikakk/comrak/pull/344 +* Sync with cmark-gfm-0.29.0.gfm.12 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/343 +* Sync with cmark-gfm-0.29.0.gfm.13 by @digitalmoksha in https://github.com/kivikakk/comrak/pull/345 + + ### 0.18.0 * Improve performance of bundled plugins, and streaming I/O by @kivikakk in https://github.com/kivikakk/comrak/pull/288