Skip to content

Commit

Permalink
docs: Fill out changelogs and configure git-cliff
Browse files Browse the repository at this point in the history
  • Loading branch information
JadedBlueEyes committed Jul 12, 2024
1 parent 4d84b55 commit 773a226
Show file tree
Hide file tree
Showing 4 changed files with 149 additions and 9 deletions.
79 changes: 79 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

[changelog]
# template for the changelog footer
header = """
# Changelog
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
"""
# template for the changelog body
# 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 %}\
{% if previous %}\
{% if previous.commit_id %}
[{{ previous.commit_id | truncate(length=7, end="") }}...\
{{ commit_id | truncate(length=7, end="") }}](https://github.com/JadedBlueEyes/messageformat/compare/{{ commit_id }}..{{ previous.commit_id }})
{% endif %}\
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
- {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/JadedBlueEyes/messageformat/commit/{{ commit.id }}))\
{% for footer in commit.footers -%}
, {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
{% endfor %}\
{% endfor %}
{% endfor %}\n
"""
# template for the changelog footer
# footer = ""
# remove the leading and trailing whitespace from the templates
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 = true
# process each line of a commit as an individual commit
split_commits = false
# 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\\(deps.*\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore|^ci", group = "Miscellaneous Tasks" },
{ body = ".*security", group = "Security" },
]
# 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
# regex for matching git tags
tag_pattern = "v[0-9]+.*"
# regex for skipping tags

# 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"
33 changes: 30 additions & 3 deletions crates/mf1-macros/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,34 @@

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).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [mf1-macros-v0.1.0] - 2024-07-12

### Bug Fixes

- Properly qualify FromStr ([e63c999](https://github.com/JadedBlueEyes/messageformat/commit/e63c999a149761d8c4b0aea46bfba977e516e588))
- Properly substitute return type for builder ([b142352](https://github.com/JadedBlueEyes/messageformat/commit/b1423525f4ead5674d1205b921aea3b0a41740b3))
- Use HashSet to avoid bogus warning ([4f3029d](https://github.com/JadedBlueEyes/messageformat/commit/4f3029d35104b389b06bf0628463bf2770bc290f))

### Documentation

- Add CHANGELOG files ([7fec2dd](https://github.com/JadedBlueEyes/messageformat/commit/7fec2ddb40381df682d1dd6fde88375b5b209ef0))
- Add descriptions to crates ([1c2c01e](https://github.com/JadedBlueEyes/messageformat/commit/1c2c01ebce34881b18a28f249c506b8f2950c6f2))

### Features

- Initial macro implementation ([5a85913](https://github.com/JadedBlueEyes/messageformat/commit/5a8591366b5b521a454d9152bbdb1534ba3415ac))
- Parse loaded locale strings in load_locales! macro ([b27f062](https://github.com/JadedBlueEyes/messageformat/commit/b27f0623b8e502b8aae598ea0f3d8a5763ce7404))
- Add initial t! macro ([4c3dc37](https://github.com/JadedBlueEyes/messageformat/commit/4c3dc37a3092188d7828ff716da4f914f0080b25))
- Add interpolation runtime support ([9412234](https://github.com/JadedBlueEyes/messageformat/commit/941223468282210ee239ccfef496f6908e74c19e))
- Add support for SelectFormat at runtime ([ab29742](https://github.com/JadedBlueEyes/messageformat/commit/ab29742c8a8c8df3f539e4e09e12f30610161411))

### Miscellaneous Tasks

- Add licences ([954312a](https://github.com/JadedBlueEyes/messageformat/commit/954312ad5ed23d4e9a2415f9ddac822f8ed24f60))

### Refactor

- Make locale string collections static structs ([cbeccf2](https://github.com/JadedBlueEyes/messageformat/commit/cbeccf23052ca79757185a94542b07dff1ab60d2))
- Embed locale strings as const rather than static ([71f69a7](https://github.com/JadedBlueEyes/messageformat/commit/71f69a7fbd59da7b7f38d869f848ceafe2705646))
24 changes: 21 additions & 3 deletions crates/mf1-parser/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,25 @@

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).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [mf1-parser-v0.1.0] - 2024-07-12

### Bug Fixes

- Use HashSet to avoid bogus warning ([4f3029d](https://github.com/JadedBlueEyes/messageformat/commit/4f3029d35104b389b06bf0628463bf2770bc290f))

### Documentation

- Add CHANGELOG files ([7fec2dd](https://github.com/JadedBlueEyes/messageformat/commit/7fec2ddb40381df682d1dd6fde88375b5b209ef0))
- Add descriptions to crates ([1c2c01e](https://github.com/JadedBlueEyes/messageformat/commit/1c2c01ebce34881b18a28f249c506b8f2950c6f2))

### Features

- Add parser for the messageformat 1 syntax ([eb08731](https://github.com/JadedBlueEyes/messageformat/commit/eb08731f1fee79ccf2ec03501789db9b9b8ca34e))
- Add trait TokenSlice with get_args methods ([1e96abf](https://github.com/JadedBlueEyes/messageformat/commit/1e96abf8118bb2a2aca955c93b796e945a74341f))
- Add support for SelectFormat at runtime ([ab29742](https://github.com/JadedBlueEyes/messageformat/commit/ab29742c8a8c8df3f539e4e09e12f30610161411))

### Miscellaneous Tasks

- Add license ([a35a618](https://github.com/JadedBlueEyes/messageformat/commit/a35a618ee255fa239a40ddee5309a40f778e53f4))
22 changes: 19 additions & 3 deletions crates/mf1/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,23 @@

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).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [mf1-v0.1.0] - 2024-07-12

### Documentation

- Add CHANGELOG files ([7fec2dd](https://github.com/JadedBlueEyes/messageformat/commit/7fec2ddb40381df682d1dd6fde88375b5b209ef0))
- Add descriptions to crates ([1c2c01e](https://github.com/JadedBlueEyes/messageformat/commit/1c2c01ebce34881b18a28f249c506b8f2950c6f2))

### Features

- Initial macro implementation ([5a85913](https://github.com/JadedBlueEyes/messageformat/commit/5a8591366b5b521a454d9152bbdb1534ba3415ac))
- Add initial t! macro ([4c3dc37](https://github.com/JadedBlueEyes/messageformat/commit/4c3dc37a3092188d7828ff716da4f914f0080b25))
- Add interpolation runtime support ([9412234](https://github.com/JadedBlueEyes/messageformat/commit/941223468282210ee239ccfef496f6908e74c19e))

### Miscellaneous Tasks

- Specify mf1-macros version in mf1 ([4d84b55](https://github.com/JadedBlueEyes/messageformat/commit/4d84b55c7a28c880b1f930150e18ef8cbd6ef038))

- Add licences ([954312a](https://github.com/JadedBlueEyes/messageformat/commit/954312ad5ed23d4e9a2415f9ddac822f8ed24f60))

0 comments on commit 773a226

Please sign in to comment.