-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Move history to CHANGELOG.md and auto-generate it (#60)
Auto-generation via git-cliff, with some tweaks by hand. This will be used in the future by release automation, as per https://blog.orhun.dev/automated-rust-releases/ CHANGELOG.md format is similar to Keep a Changelog.
- Loading branch information
Showing
3 changed files
with
134 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is similar to [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [0.15.0] - 2023-02-25 | ||
|
|
||
| - **Dependency:** Update Rust crate sentry to 0.30.0 ([#55](https://github.com/intgr/rocket-sentry/pull/55)) | ||
|
|
||
| ## [0.14.0] - 2023-01-08 | ||
|
|
||
| - **Dependency:** Update Rust crate sentry to 0.29.1 ([#53](https://github.com/intgr/rocket-sentry/pull/53)) | ||
|
|
||
| ## [0.13.0] - 2022-11-08 | ||
|
|
||
| - **Dependency:** Update Rust crate sentry to 0.28.0 ([#51](https://github.com/intgr/rocket-sentry/pull/51)) | ||
|
|
||
| ## [0.12.0] - 2022-09-30 | ||
|
|
||
| - **Added** Log a message when Sentry events are sent ([#48](https://github.com/intgr/rocket-sentry/pull/48)) | ||
| - **Dependency:** Update Rust crate sentry to 0.27.0 ([#44](https://github.com/intgr/rocket-sentry/pull/44)) | ||
|
|
||
| ## [0.11.0] - 2022-05-22 | ||
|
|
||
| - **Dependency:** Update Rust crate sentry to 0.26.0 ([#42](https://github.com/intgr/rocket-sentry/pull/42)) | ||
| - **Dependency:** Update Rust crate rocket to 0.5.0-rc.2 ([#39](https://github.com/intgr/rocket-sentry/pull/39)) | ||
| - **Chore:** Update to Rust 2021 edition ([#41](https://github.com/intgr/rocket-sentry/pull/41)) | ||
| - **CI:** Use up to date nightly Rust in CI ([#40](https://github.com/intgr/rocket-sentry/pull/40)) | ||
|
|
||
| ## [0.10.0] - 2022-03-26 | ||
|
|
||
| - **Dependency:** Update Rust crate sentry to 0.25.0 ([#31](https://github.com/intgr/rocket-sentry/pull/31)) | ||
|
|
||
| ## [0.9.0] - 2022-01-22 | ||
|
|
||
| - **Dependency:** Update Rust crate sentry to 0.24.1 ([#28](https://github.com/intgr/rocket-sentry/pull/28)) | ||
|
|
||
| ## [0.8.0] - 2021-11-22 | ||
|
|
||
| - **[Breaking] Changed:** Update to Rocket 0.5-rc ([#23](https://github.com/intgr/rocket-sentry/pull/23)) | ||
| * To continue using Rocket 0.4.x, stay with rocket-sentry 0.7.0 | ||
| * Now using figment and serde for configuration (as required by Rocket) | ||
| * The fairing no longer needs to have `Response` kind | ||
| * RocketSentry now uses fairing kind `Singleton` | ||
|
|
||
| ## [0.7.0] - 2021-07-13 | ||
|
|
||
| - **Dependency:** Update sentry requirement from 0.22 to 0.23 ([#20](https://github.com/intgr/rocket-sentry/pull/20)) | ||
| - **Chore:** Fix Rust 1.52 warning "panic message is not a string literal" ([#18](https://github.com/intgr/rocket-sentry/pull/18)) | ||
|
|
||
| ## [0.6.0] - 2021-01-26 | ||
|
|
||
| - **Dependency:** Update sentry requirement from 0.20 to 0.22 ([#16](https://github.com/intgr/rocket-sentry/pull/16)) | ||
|
|
||
| ## [0.5.0] - 2020-09-15 | ||
|
|
||
| - **Dependency:** Update sentry requirement from 0.19 to 0.20 ([#13](https://github.com/intgr/rocket-sentry/pull/13)) | ||
|
|
||
| ## [0.4.0] - 2020-08-16 | ||
|
|
||
| - **Changed:** Use log crate instead of println ([#11](https://github.com/intgr/rocket-sentry/pull/11)) | ||
|
|
||
| Contributed by **Afonso Bordado** | ||
|
|
||
| ## [0.3.0] - 2020-07-22 | ||
|
|
||
| - **Changed:** Sentry now automatically installs panic handler, dropped from rocket-sentry ([#9](https://github.com/intgr/rocket-sentry/pull/9)) | ||
| - **Dependency:** Update sentry requirement from 0.18.0 to 0.19.0 ([#9](https://github.com/intgr/rocket-sentry/pull/9)) | ||
|
|
||
| ## [0.2.0] - 2020-04-04 | ||
|
|
||
| - **Dependency:** Update sentry requirement from 0.12.0 to 0.18.0 ([#1](https://github.com/intgr/rocket-sentry/pull/1)) | ||
| - **CI:** Add CI builds and basic test case ([#3](https://github.com/intgr/rocket-sentry/pull/3), [#4](https://github.com/intgr/rocket-sentry/pull/4)) | ||
| - **Documentation:** Add documentation for Rust doc ([#5](https://github.com/intgr/rocket-sentry/pull/5)) | ||
|
|
||
| ## [0.1.0] - 2019-11-25 | ||
| - Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # git-cliff changelog generator configuration file | ||
| # https://git-cliff.org/docs/configuration | ||
|
|
||
| [git] | ||
| filter_unconventional = false | ||
| sort_commits = "newest" | ||
| tag_pattern = "[0-9]+\\.[0-9].*" | ||
| commit_preprocessors = [ | ||
| # Keep only first line of commit message | ||
| { pattern = "^([^\n]+)\n(?s:.*)", replace = "${1}"}, | ||
| # Pull request links in commit message | ||
| { pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](https://github.com/intgr/rocket-sentry/pull/${1}))"}, | ||
| ] | ||
| commit_parsers = [ | ||
| { message = "^ci:", group = "CI" }, | ||
| { message = "^feat:", group = "Feature" }, | ||
| { message = "^docs:", group = "Documentation" }, | ||
| { message = "^Update Rust crate", group = "Dependency" }, | ||
| { message = "^Update .+ requirement", group = "Dependency" }, | ||
| { message = "^Merge branch", skip = true }, | ||
| { message = "^Update actions/", skip = true }, | ||
| { message = "^Prepare for .+ release", skip = true }, | ||
| ] | ||
|
|
||
| [changelog] | ||
| # template for the changelog body | ||
| # https://keats.github.io/tera/docs/#introduction | ||
| header = """ | ||
| # Changelog | ||
| All notable changes to this project will be documented in this file. | ||
| The format is similar to [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).\n | ||
| """ | ||
| body = """ | ||
| {% if version %}\ | ||
| ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}\ | ||
| {% else %}\ | ||
| ## [unreleased]\ | ||
| {% endif %}\ | ||
| \n | ||
| {% for commit in commits %}\ | ||
| - \ | ||
| {% if commit.group %}**\ | ||
| {% if commit.breaking %}[Breaking] {% endif %}\ | ||
| {{ commit.group | upper_first }}:** \ | ||
| {% endif %}\ | ||
| {{ commit.message | upper_first }} | ||
| {% if commit.author.name and commit.author.name is not matching("\\[bot\\]|Marti Raudsepp") %} | ||
| {# keep whitespace #} Contributed by **{{ commit.author.name }}** | ||
| {% endif %}\ | ||
| {% endfor %}\n | ||
| """ |