Skip to content

Add dependency changelog type #579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 20, 2025
Merged

Add dependency changelog type #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
701a19a
Add dependency changelog type
jonathan343 Oct 17, 2025
1f7b8e7
formatter
jonathan343 Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion scripts/changelog/new-entry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def main():
"-t",
"--type",
# TODO: Remove the 'breaking' option once this project is stable.
choices=("feature", "enhancement", "bugfix", "breaking"),
choices=("feature", "enhancement", "bugfix", "breaking", "dependency"),
required=True,
help="Type of change",
)
Expand Down
8 changes: 7 additions & 1 deletion scripts/changelog/new-release.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@

PROJECT_ROOT_DIR = Path(__file__).resolve().parent.parent.parent
VERSION_PATTERN = r"^\d+\.\d+\.\d+$"
CHANGE_TYPES_ORDER = {"breaking": 0, "feature": 1, "enhancement": 2, "bugfix": 3}
CHANGE_TYPES_ORDER = {
"breaking": 0,
"feature": 1,
"enhancement": 2,
"bugfix": 3,
"dependency": 4,
}
CHANGE_TYPES = tuple(CHANGE_TYPES_ORDER.keys())


Expand Down
5 changes: 4 additions & 1 deletion scripts/changelog/templates/PACKAGE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Changelog
{% for release, changes in releases %}
## v{{ release }}
{%- for type_name in ['breaking', 'feature', 'enhancement', 'bugfix'] %}
{%- for type_name in ['breaking', 'feature', 'enhancement', 'bugfix', 'dependency'] %}
{%- for change in changes.changes if change.type == type_name %}
{%- if loop.first %}
{%- if type_name == 'breaking' %}
Expand All @@ -16,6 +16,9 @@
{%- elif type_name == 'bugfix' %}

### Bug fixes
{%- elif type_name == 'dependency' %}

### Dependencies
{%- endif %}
{%- endif %}
* {{ change.description }}
Expand Down
Loading