Use git-cliff to generate CHANGELOG (with some manual editions)

Use git-cliff for automatic generation of the Changelog, in the 'Keep a Changelog' format. However, we do not use it in fully automatic mode: previous changes are not all in the correct format and this would loose some content (but do we care?). This may be considered again in the future to switch to fully automatic.

Author: chifflier

CHANGELOG.md

@@ -1,10 +1,52 @@
-# Change Log
+<!-- generated by `git cliff -u -p CHANGELOG.md` and edited to set version -->
+# Changelog
 
-## [Unreleased][unreleased]
+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).
+
+## [0.17.0]
 
 ### Added
 
-### Changed/Fixed
+- Add benchmarks (using criterion)
+- Add example to display information about pcap file
+- Add method to get shb_hardware option value from SHB
+- Add helpers for SHB options
+- Add helper to get IPv4Addr and IPv6Addr from IDB
+- Add helpers to get the most common options for IDB
+- Add documentation for PcapNGOption structure and fields
+- Add unit test for timestamp decoding
+- Add helpers to get the most common options for ISB
+- Add Send trait bound to create_reader so I can use this in async context
+
+### Changed
+
+- Change `as_xxx()` function to return an error if length or value is invalid
+- Start adding helper functions for IDB and factorize code
+- Adjust lifetime in trait definition
+- Bump rustsec/audit-check from 1 to 2
+- Disable protobuf output in benchmarks (Closes #49)
+- Upgrade nom to version 8.0
+- Update MSRV to 1.65 (for nom 8)
+- Upgrade pprof to 0.15 (Closes #46)
+- Bump the crates-io group across 1 directory with 2 updates
+- Keep criterion dev-dependency to 0.5, pprof is not yet compatible with 0.6
+
+### Fixed
+
+- Fix PcapNGOption 32 bits conversions
+- Fix typo
+- Fix Correct header detection in LegacyPcapReader
+
+### Other
+
+- Fix clippy warnings: elided lifetime has a name
+- Fix (nightly) clippy warnings: explicit lifetime could be elided
+- Generate lockfile (to see if that fixes rustsec/audit-check v2 failures)
+- Fix clippy warnings: inline arguments in `println!`/`format!`
+- Fix clippy (nightly) warning: error: hiding a lifetime that's elided elsewhere is confusing
+- Update cargo-check-external-types toolchain
+- Ignore errors in check-external-types for now
 
 ## 0.16.0
 

cliff.toml

@@ -0,0 +1,84 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+# A Tera template to be rendered as the changelog's header.
+# See https://keats.github.io/tera/docs/#introduction
+header = """
+<!-- generated by `git cliff -u -p CHANGELOG.md` and edited to set version -->
+# Changelog\n
+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).\n
+"""
+# A Tera template to be rendered for each release in the changelog.
+# See https://keats.github.io/tera/docs/#introduction
+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 %}
+ - {{ commit.message | split(pat="\n") | first | upper_first | trim }}\
+ {% endfor %}
+{% endfor %}\n
+"""
+# A Tera template to be rendered as the changelog's footer.
+# See https://keats.github.io/tera/docs/#introduction
+footer = """
+{% for release in releases -%}
+ {% if release.version -%}
+ {% if release.previous.version -%}
+ [{{ release.version | trim_start_matches(pat="v") }}]: \
+ https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
+ /compare/{{ release.previous.version }}..{{ release.version }}
+ {% endif -%}
+ {% else -%}
+ [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
+ /compare/{{ release.previous.version }}..HEAD
+ {% endif -%}
+{% endfor %}
+<!-- generated by git-cliff -->
+"""
+# Remove leading and trailing whitespaces from the changelog's body.
+trim = true
+
+[git]
+# Parse commits according to the conventional commits specification.
+# See https://www.conventionalcommits.org
+conventional_commits = true
+# Exclude commits that do not match the conventional commits specification.
+filter_unconventional = false
+# An array of regex based parsers for extracting data from the commit message.
+# Assigns commits to groups.
+# Optionally sets the commit's scope and can decide to exclude commits from further processing.
+commit_parsers = [
+ { message = "^[a|A]dd", group = "Added" },
+ { message = "^[s|S]upport", group = "Added" },
+ { message = "^[r|R]emove", group = "Removed" },
+ { message = "^[Cc][Ii]:", group = "Other" },
+ { message = "clippy", group = "Other" },
+ { message = "^.*: add", group = "Added" },
+ { message = "^.*: support", group = "Added" },
+ { message = "^.*: remove", group = "Removed" },
+ { message = "^.*: delete", group = "Removed" },
+ { message = "^test", group = "Fixed" },
+ { message = "^[f|F]ix", group = "Fixed" },
+ { message = "^.*: fix", group = "Fixed" },
+ { message = "^.*", group = "Changed" },
+]
+# Prevent commits that are breaking from being excluded by commit parsers.
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "pcap-parser-[0-9]*"
+# regex for skipping tags
+skip_tags = ".*-rc|.*-alpha|.*-beta"
+# regex for ignoring tags
+ignore_tags = ""
+# Order releases topologically instead of chronologically.
+topo_order = false
+# Order of commits in each group/release within the changelog.
+# Allowed values: newest, oldest
+sort_commits = "oldest"