diff --git a/CHANGELOG.md b/CHANGELOG.md index 1931972..b404743 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,27 +1,137 @@ # Changelog + All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [unreleased] + +### Bug Fixes + +- Fix link in README.md + +### Features + +- Add log_service client +- Make log service client cloneable + +### Miscellaneous Tasks + +- Remove useless trait +- Add log service example and update test +- Update log_service example +- Update base16ct and base64 version +- Update author info in LICENSE file +- Add editor config file +- Add rustfmt.toml file +- Use max_width default setting in rustfmt.toml file +- Add log_service example in README.md +- Update RPC & ROA client example +- Add dependabot.yml of github +- Update lib doc + +## [1.0.0] - 2023-06-17 + +### Bug Fixes + +- Fix signature bug with `POST` method in rpc style client +- Fix lib document test error + +### Documentation + +- Update badges +- Add badges link +- Add NLP example +- Add usage of ROA style client + +### Features + +- Add roa style client +- Add timeout function for ROA style client +- Add timeout function for RPC style client +- Add `post` function for RPC style client +- Add `post` function for ROA style client +- Update ROA style client +- Add async rpc style client +- Add async roa style client +- Make async client cloneable + +### Miscellaneous Tasks + +- Add cargo-audit for ci workflow +- Upgrade dependencies +- Make clippy happy +- Update lib document +- Update ROA style client test and lib document +- Update ecs api example +- Update RPC style client examples +- Update ROA style client examples +- Add deprecated message for old client +- Update examples +- Update async RPC style client test +- Update README for release 1.0.0 + +### Other + +- Merge tag 'v0.3.0' into develop + +no message -## [Unreleased] +- Merge branch 'hotfix/fix-doc-badges' -### Added -- ROA style client. +- Merge tag 'fix-doc-badges' into develop + +no message + + +### Refactor + +- Announcing the new async client +- Move unit tests from tests directory to the same source file +- Remove chrono, rust-crypto dependencies +- Use uuid::v4 for nonce field sign + +### Testing + +- Add compatibility test case +- Cargo fmt +- Add test case for ROA style client +- Disable deprecated warning of compatibility tests +- Add unit test for async RPC style client ## [0.3.0] - 2019-09-21 -### Added -- New function(`get`, `query`, `send`) for RPC style client. +### Documentation + +- Add crates badge, remove install description +- Add github actions badge + +### Miscellaneous Tasks + +- Add ci by github actions + +### Other -### Deprecated -- `request` function is deprecated, please use the `get` function instead. +- Merge branch 'release/v0.3.0' + + +### Refactor + +- New function(`get`, `query`, `send`) for RPC style client + +### Testing + +- Add test case for RPC style client ## [0.2.0] - 2019-09-01 -### Changed -- pass params of `RPClient::request` from by-copy to by-borrow. +### Refactor + +- Pass params of `RPClient::request` from by-copy to by-borrow ## [0.1.0] - 2019-08-31 -Initial release. +### Other + +- Initial commit + + + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..e0cbb1f --- /dev/null +++ b/cliff.toml @@ -0,0 +1,76 @@ +# 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://tera.netlify.app/docs +body = """ +{% if version %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} +{% else %}\ + ## [unreleased] +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | upper_first }} + {% for commit in commits %} + - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\ + {% endfor %} +{% endfor %}\n +""" +# remove the leading and trailing whitespace from the template +trim = true +# changelog footer +footer = """ + +""" + +[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 = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers +] +# regex for parsing and grouping commits +commit_parsers = [ + {message = "^feat", group = "Features"}, + {message = "^fix", group = "Bug Fixes"}, + {message = "^doc", group = "Documentation"}, + {message = "^perf", group = "Performance"}, + {message = "^refactor", group = "Refactor"}, + {message = "^style", group = "Styling"}, + {message = "^test", group = "Testing"}, + {message = "^chore\\(release\\): prepare for", skip = true}, + {message = "^chore", group = "Miscellaneous Tasks"}, + {body = ".*security", group = "Security"}, + {message = ".*", group = "Other", default_scope = "other"}, +] +# 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 +# glob pattern for matching git tags +tag_pattern = "[0-9]*" +# regex for skipping tags +skip_tags = "v0.1.0-beta.1" +# regex for ignoring tags +ignore_tags = "" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "oldest" +# limit the number of commits included in the changelog. +# limit_commits = 42