diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7898770 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,48 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [0.1.0] - 2023-09-25 + +### Documentation + +- Document the structure of the crate +- Describe functionality +- Align readme & documentation, add an example ([#34](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/34)) +- Add logo + +### Features + +- Init previously existed modules within `testcontainers-rs` ([#1](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/1)) + +### Miscellaneous Tasks + +- Set version to `0.1.0` +- Configure automatic dependency updates ([#7](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/7)) +- Bump Swatinem/rust-cache from 2.5.0 to 2.5.1 ([#8](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/8)) +- Bump Swatinem/rust-cache from 2.5.1 to 2.6.0 ([#16](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/16)) +- Bump Swatinem/rust-cache from 2.6.0 to 2.6.2 ([#19](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/19)) +- Bump actions/checkout from 3 to 4 ([#25](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/25)) +- Bump Swatinem/rust-cache from 2.6.2 to 2.7.0 ([#26](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/26)) +- Bump MSRV ([#31](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/31)) +- Add issue templates ([#32](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/32)) +- Add release workflow +- Add config for `git-cliff` & `release-plz` + +### Refactor + +- Remove `coblox-bitcoincore` module ([#30](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/30)) +- Use bitnami image ([#33](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/33)) + +### Build + +- Update rdkafka requirement from 0.32.2 to 0.33.2 ([#9](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/9)) +- Update aws-types requirement from 0.55.3 to 0.56.0 ([#11](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/11)) +- Update zookeeper requirement from 0.7 to 0.8 ([#15](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/15)) +- Update rdkafka requirement from 0.33.2 to 0.34.0 ([#20](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/20)) +- Update aws-config requirement from 0.55.3 to 0.56.1 ([#24](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/24)) +- Update aws-sdk-s3 requirement from 0.28.0 to 0.31.2 ([#27](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/27)) +- Update aws-sdk-sqs requirement from 0.28.0 to 0.31.1 ([#29](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/29)) +- Update aws-sdk-dynamodb requirement from 0.28.0 to 0.31.1 ([#28](https://github.com/testcontainers/testcontainers-rs-modules-community/pull/28)) + + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..c6d457b --- /dev/null +++ b/cliff.toml @@ -0,0 +1,80 @@ +# 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 = """ + +""" +# postprocessors +postprocessors = [ + # { pattern = '', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL +] +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = true +# 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}](/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\\(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" }, +] +# 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 = "v[0-9]*" +# 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 diff --git a/release-plz.toml b/release-plz.toml new file mode 100644 index 0000000..d03bd2d --- /dev/null +++ b/release-plz.toml @@ -0,0 +1,4 @@ +[workspace] +changelog_config = "cliff.toml" # use a custom git-cliff configuration +git_release_enable = true # enable GitHub releases +pr_labels = ["release"] # add the `release` label to the release Pull Request