qpath 0.1.1

Register, list, and maintain frequently used file and directory paths
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# git-cliff configuration for qpath.
# Keep a Changelog-style sections, populated from commit subjects.

[changelog]
header = """
# Changelog

All notable changes to this project are documented here.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
While on `0.x.y`, the minor version bumps for new features and the patch
version bumps for fixes.  Once `1.0.0` ships, the project will revisit and
likely adopt strict [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

"""
body = """

{% if version -%}
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{%- else -%}
## [Unreleased]
{%- endif %}
{% if not previous.version %}
- Initial release.
{%- else %}
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
- {{ commit.message | split(pat="\\n") | first | trim }}
{%- endfor %}
{% endfor %}
{%- endif %}
"""
trim = true
footer = ""

[git]
conventional_commits = false
filter_unconventional = false
split_commits = false
protect_breaking_commits = false
filter_commits = true
tag_pattern = "v[0-9]*"
sort_commits = "oldest"

# Order matters: the first matching parser wins.
commit_parsers = [
  # Skip commits that are not user-visible.
  { message = "^Initial commit\\b", skip = true },
  { message = "^Merge\\b", skip = true },
  { message = "^Revert\\b", skip = true },
  { message = "^Release v?[0-9]", skip = true },
  # Explicit skip markers in the subject, e.g. "[chore]", "[doc]", "[ci skip]".
  # Anchor the keyword patterns to the subject line so the body of a
  # user-visible commit can mention README, CI, etc. without making
  # git-cliff drop the whole commit.
  { message = "(?i)^[^\\n]*\\[(chore|docs?|ci skip|skip ci|skip changelog|no changelog)\\]", skip = true },
  # Note: match "formatter"/"formatting" but not the standalone word "format",
  # which qpath uses for its `format` subcommand (a user-visible feature).
  { message = "(?i)^[^\\n]*\\b(CI|GitHub Actions?|workflows?|Dependabot|Renovate|Harden-?Runner|pre-?commit|lint(er|ing)?|formatter|formatting|prettier|eslint|rubocop|zizmor|actionlint)\\b", skip = true },
  { message = "(?i)^[^\\n]*\\b(README|docs?|documentation|comment|changelog|license|privacy policy|listing copy)\\b", skip = true },
  { message = "^(Refactor|Rework|Reformat|Clean ?up|Reorganize|Rename|Move|Format|Tidy|Tweak|Polish|Simplify|Inline|Extract|Restructure|Factor)\\b", skip = true },
  { message = "^(Test|Tests)\\b", skip = true },

  # Dependency-bot commits are skipped by author, with subject fallbacks for
  # manual cherry-picks or squash commits.
  { field = "author.name", pattern = "(?i)(dependabot|renovate)(\\[bot\\])?$", skip = true },
  { field = "author.email", pattern = "(?i)@(dependabot|renovate)\\b", skip = true },
  { field = "author.email", pattern = "^[0-9]+\\+(dependabot|renovate)(\\[bot\\])?@", skip = true },
  { message = "^Bump\\b", skip = true },
  { message = "^Update dependency\\b", skip = true },

  # Conventional Commits: internal-only types.
  { message = "^(chore|ci|build|docs?|test|tests|style|refactor|perf|revert)(\\(.+?\\))?!?:", skip = true },
  { body = "(?im)^chore\\b", skip = true },

  # Conventional Commits: user-visible types.
  { message = "^feat(\\(.+?\\))?!?:", group = "Added" },
  { message = "^fix(\\(.+?\\))?!?:", group = "Fixed" },
  { message = "^remove(\\(.+?\\))?!?:", group = "Removed" },
  { message = "^deprecate(\\(.+?\\))?!?:", group = "Deprecated" },
  { message = "^(security|sec)(\\(.+?\\))?!?:", group = "Security" },

  # Traditional subjects.
  { message = "^(Add|Introduce|Implement|Support|Allow|Enable|Expose|Show|Define|Install|Include)\\b", group = "Added" },
  { message = "^(Fix|Correct|Repair|Resolve|Prevent|Avoid|Stop|Guard|Handle|Rescue|Protect|Properly|Stabilize)\\b", group = "Fixed" },
  { message = "^(Remove|Drop|Delete|Retire|Disable|Exclude|Omit|Skip|Ignore|Turn off)\\b", group = "Removed" },
  { message = "^Deprecate\\b", group = "Deprecated" },
  { message = "^(Secure|Harden|Sanitize)\\b", group = "Security" },

  # Keep this catch-all last.
  { message = ".*", group = "Changed" },
]