Add dependency changelog type (#579)

* Add dependency changelog type

* formatter

Author: jonathan343

scripts/changelog/new-entry.py

@@ -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",
     )

scripts/changelog/new-release.py

@@ -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())
 
 

scripts/changelog/templates/PACKAGE

@@ -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' %}
@@ -16,6 +16,9 @@
 {%- elif type_name == 'bugfix' %}
 
 ### Bug fixes
+{%- elif type_name == 'dependency' %}
+
+### Dependencies
 {%- endif %}
 {%- endif %}
 * {{ change.description }}