From acee67f87020ef41267fe475bcc5cbed44782a06 Mon Sep 17 00:00:00 2001 From: Kevin Guthrie Date: Fri, 5 Apr 2024 15:29:03 -0400 Subject: [PATCH] Adding 0.1.1 changelog --- CHANGELOG.md | 35 +++++++++++++++++++++ cliff.toml | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 122 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 cliff.toml diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d0bfcee --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [0.1.1](https://github.com/cloudflare/pingora/compare/0.1.0...0.1.1) - 2024-04-05 + +### ๐Ÿš€ Features +- `Server::new` now accepts `Into>` +- Implemented client `HttpSession::get_keepalive_values` for Keep-Alive parsing +- Expose `ListenFds` and `Fds` to fix a voldemort types issue +- Expose config options in `ServerConf`, provide new `Server` constructor +- `upstream_response_filter` now runs on upstream 304 responses during cache revalidation +- Added `server_addr` and `client_addr` APIs to `Session` +- Allow body modification in `response_body_filter` +- Allow configuring grace period and graceful shutdown timeout +- Added TinyUFO sharded skip list storage option + +### ๐Ÿ› Bug Fixes +- Fixed build failures with the `boringssl` feature +- Fixed compile warnings with nightly Rust +- Fixed an issue where Upgrade request bodies might not be handled correctly +- Fix compilation to only include openssl or boringssl rather than both +- Fix OS read errors so they are reported as `ReadError` rather than `ReadTimeout` when reading http/1.1 response headers + +### โš™๏ธ Miscellaneous Tasks +- Performance improvements in `pingora-ketama` +- Added more TinyUFO benchmarks +- Added tests for `pingora-cache` purge +- Limit buffer size for `InvalidHTTPHeader` error logs +- Example code: improvements in pingora client, new LB cluster example +- Typo fixes and clarifications across comments and docs + +## [0.1.0] - 2024-02-28 +### Highlights +- First Public Release of Pingora ๐ŸŽ‰ diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..43c402a --- /dev/null +++ b/cliff.toml @@ -0,0 +1,87 @@ +# git-cliff ~ default configuration file +# https://git-cliff.org/docs/configuration +# +# Lines starting with "#" are comments. +# Configuration options are organized into tables and keys. +# See documentation for more information on available options. + +[changelog] +# changelog header +header = """ +# Changelog\n +All notable changes to this project will be documented in this file.\n +""" +# template for the changelog body +# https://keats.github.io/tera/docs/#introduction +body = """ +{% if version %}\ + {% if previous.version %}\ + ## [{{ version | trim_start_matches(pat="v") }}](https://github.com/cloudflare/pingora/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} + {% else %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} + {% endif %}\ +{% else %}\ + ## [unreleased] +{% endif %}\ + +### Highlights + - Human-written change summaries go here + +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | striptags | trim | upper_first }} + {% for commit in commits %} + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ + {% if commit.breaking %}[**breaking**] {% endif %}\ + {{ commit.message | upper_first }}\ + {% endfor %} +{% endfor %}\n +""" +# template for the changelog footer +footer = """ +""" +# remove the leading and trailing whitespace +trim = true + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true + +# filter out the commits that are not conventional +filter_unconventional = false + +# process each line of a commit as an individual commit +split_commits = false + +# regex for preprocessing the commit messages +commit_preprocessors = [ + { pattern = '\n\w+(?:\-\w+)*:\s+[^\n]+', replace = "\n" }, + { pattern = '\n+', replace = "\n " }, + { pattern = '\s+$', replace = "" } +] + +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "๐Ÿš€ Features" }, + { message = "^fix", group = "๐Ÿ› Bug Fixes" }, + { message = "^doc", group = "๐Ÿ“š Documentation", skip = true }, + { message = "^perf", group = "โšก Performance" }, + { message = "^refactor", group = "๐Ÿšœ Refactor", skip = true }, + { message = "^style", group = "๐ŸŽจ Styling", skip = true }, + { message = "^test", group = "๐Ÿงช Testing", skip = true }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(deps.*\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, + { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, + { message = "^revert", group = "โ—€๏ธ Revert" }, + { message = '\S+(?:\s+\S+){6,}', group = " Everything Else" } +] + +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false + +# filter out the commits that are not matched by commit parsers +filter_commits = false +tag_pattern = "[0-9].[0-9].[0-9]" +topo_order = false \ No newline at end of file