Skip to content

Commit

Permalink
chore(changelog): add cliff configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
nickmessing committed Jul 7, 2024
1 parent f753e0f commit e912f99
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## What's Changed
* chore(changelog): add cliff configuration
* fix: fix after upgrade to tinybase v5 by @nickmessing
* test(mock): add a mock store to base tests on by @nickmessing
* ci(test): rename test workflow job by @nickmessing
* ci(test): add test workflow by @nickmessing
* test(context): provideStore + injectStore by @nickmessing
* chore(deps): update dependencies by @nickmessing

## What's Changed in v0.3.1
* 0.3.1 by @nickmessing
* fix(store): fix default-store onSortedRowIdsChange types by @nickmessing
* feat(store): add useSortedRowIds composable by @nickmessing
* docs: add install vue-tinybase section by @nickmessing
* docs: oops by @nickmessing
* docs: add link to the docs to the readme by @nickmessing

**Full Changelog**: https://github.com/nickmessing/vue-tinybase/compare/v0.3.0...v0.3.1

## What's Changed in v0.3.0
* 0.3.0 by @nickmessing
* chore: sync versions by @nickmessing
* docs(guide): add guide to the docs by @nickmessing
* build: oops by @nickmessing
* build(docker): add docs build dockerfile by @nickmessing
* docs: fix logo display in docs by @nickmessing
* docs: fix docs building by @nickmessing
* feat(api): full API refactor + docs by @nickmessing
* chore(version): release v0.2.2 by @nickmessing

**Full Changelog**: https://github.com/nickmessing/vue-tinybase/compare/v0.2.2...v0.3.0

## What's Changed in v0.2.2
* chore(version): release v0.2.1 by @nickmessing

**Full Changelog**: https://github.com/nickmessing/vue-tinybase/compare/v0.2.1...v0.2.2

## What's Changed in v0.2.1
* fix(composables): handle dependency changes in composables by @nickmessing

**Full Changelog**: https://github.com/nickmessing/vue-tinybase/compare/v0.2.0...v0.2.1

## What's Changed in v0.2.0
* chore(version): release v0.2.0 by @nickmessing
* refactor(core): auto-generate event handlers and composables by @nickmessing
* feat: initial version by @nickmessing

<!-- generated by git-cliff -->
88 changes: 88 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

# [remote.github]
# owner = "orhun"
# repo = "git-cliff"
# token = ""

[changelog]
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
## What's Changed
{%- if version %} in {{ version }}{%- endif -%}
{% for commit in commits %}
{% if commit.github.pr_title -%}
{%- set commit_message = commit.github.pr_title -%}
{%- else -%}
{%- set commit_message = commit.message -%}
{%- endif -%}
* {{ commit_message | split(pat="\n") | first | trim }}\
{% if commit.github.username %} by @{{ commit.github.username }}{%- endif -%}
{% if commit.github.pr_number %} in \
[#{{ commit.github.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.github.pr_number }}) \
{%- endif %}
{%- endfor -%}
{%- if github -%}
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
{% raw %}\n{% endraw -%}
## New Contributors
{%- endif %}\
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
* @{{ contributor.username }} made their first contribution
{%- if contributor.pr_number %} in \
[#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
{%- endif %}
{%- endfor -%}
{%- endif -%}
{% if version %}
{% if previous.version %}
**Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}
{% endif %}
{% else -%}
{% raw %}\n{% endraw %}
{% endif %}
{%- macro remote_url() -%}
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}
"""
# remove the leading and trailing whitespace from the template
trim = true
# changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# postprocessors
postprocessors = []

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = false
# 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 = [
# remove issue numbers from commits
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
]
# 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
skip_tags = "beta|alpha"
# regex for ignoring tags
ignore_tags = "rc"
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"

0 comments on commit e912f99

Please sign in to comment.