From 97bf920bd87ba60b0baca1aa40938b1be42f87fe Mon Sep 17 00:00:00 2001 From: Dorian Turba Date: Mon, 17 Nov 2025 10:46:00 +0000 Subject: [PATCH] add Breaking to categories --- README.md | 2 +- pyconfr/slides.md | 2 +- src/cli_tests.rs | 3 ++- src/config.rs | 1 + src/config_tests.rs | 3 +++ src/ezchlog/config.py | 1 + tests/test_config.py | 1 + 7 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 196db8a..ae3f189 100644 --- a/README.md +++ b/README.md @@ -155,7 +155,7 @@ The following configuration parameters could be specified as environment variabl - `EZCHLOG_EDITOR` default to `EDITOR` or `vim` - `EZCHLOG_LOG_DIR` default to `_CHANGELOGS` - `EZCHLOG_LOG_FILE` default to `CHANGELOG.md` -- `EZCHLOG_CATEGORY_LIST` default to `Security,Fixed,Changed,Added,Removed,Deprecated` +- `EZCHLOG_CATEGORY_LIST` default to `Breaking,Security,Fixed,Changed,Added,Removed,Deprecated` - `EZCHLOG_CATEGORY_DEFAULT` default to `Changed` - `EZCHLOG_DEFAULT_CHANGELOG` default to ``` diff --git a/pyconfr/slides.md b/pyconfr/slides.md index e9c32f9..be08ae5 100644 --- a/pyconfr/slides.md +++ b/pyconfr/slides.md @@ -368,7 +368,7 @@ _CHANGELOGS/Added/add_django_as_dependency.md cyrille@host$ ezchlog showconfig log_file = /home/cyrille/Documents/Projets/ezchlog/CHANGELOG.md log_dir = /home/cyrille/Documents/Projets/ezchlog/_CHANGELOGS -category_list = ['Security', 'Fixed', 'Changed', 'Added', 'Removed', 'Deprecated'] +category_list = ['Breaking', 'Security', 'Fixed', 'Changed', 'Added', 'Removed', 'Deprecated'] category_default = Changed default_changelog = # Changelog diff --git a/src/cli_tests.rs b/src/cli_tests.rs index a8f0f83..f69e9ae 100644 --- a/src/cli_tests.rs +++ b/src/cli_tests.rs @@ -12,6 +12,7 @@ mod cli_tests { fn get_categories_test() { let cats = get_categories(); let expected_cats = vec![ + "Breaking", "Security", "Fixed", "Changed", @@ -45,7 +46,7 @@ mod cli_tests { let err = category_value_parser("Bad").unwrap_err(); assert_eq!( err, - "should be one of Security, Fixed, Changed, Added, Removed, Deprecated" + "should be one of Breaking, Security, Fixed, Changed, Added, Removed, Deprecated" ); } diff --git a/src/config.rs b/src/config.rs index 2bd1caa..b256e34 100644 --- a/src/config.rs +++ b/src/config.rs @@ -15,6 +15,7 @@ pub const ROOT_FILE_NAMES: [&str; 4] = [ const DEFAULT_MAIN_CHANGELOG: &str = "CHANGELOG.md"; const DEFAULT_CHANGELOG_DIR: &str = "_CHANGELOGS"; const DEFAULT_CATEGORIES: &[&str] = &[ + "Breaking", "Security", "Fixed", "Changed", diff --git a/src/config_tests.rs b/src/config_tests.rs index fa665d0..242be06 100644 --- a/src/config_tests.rs +++ b/src/config_tests.rs @@ -17,6 +17,7 @@ mod cli_tests { assert_eq!( cfg.category_list, vec![ + "Breaking", "Security", "Fixed", "Changed", @@ -133,6 +134,7 @@ branch_lowercase_for = ["ref", "name"] assert_eq!( cfg_map.get("category_list"), Some(ConfigValue::List(vec![ + "Breaking".to_string(), "Security".to_string(), "Fixed".to_string(), "Changed".to_string(), @@ -201,6 +203,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. assert_eq!( cfg.get_categories(), vec![ + "Breaking".to_string(), "Security".to_string(), "Fixed".to_string(), "Changed".to_string(), diff --git a/src/ezchlog/config.py b/src/ezchlog/config.py index b551b43..0eea530 100644 --- a/src/ezchlog/config.py +++ b/src/ezchlog/config.py @@ -42,6 +42,7 @@ DEFAULTS = ConfigParams( log_file='CHANGELOG.md', log_dir='_CHANGELOGS', category_list=[ + 'Breaking', 'Security', 'Fixed', 'Changed', diff --git a/tests/test_config.py b/tests/test_config.py index 547b479..3ccf058 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -23,6 +23,7 @@ def test_config_init_no_conf(environ, git_dir, editorconfig, ezchlogconf, pyproj assert cfg.log_file == root_path / 'CHANGELOG.md' assert cfg.log_dir == root_path / '_CHANGELOGS' assert cfg.category_list == [ + 'Breaking', 'Security', 'Fixed', 'Changed', -- GitLab