From 642e8339999c2a216f98f97f1eb5b9e54f0e48a8 Mon Sep 17 00:00:00 2001 From: Yagnesh Date: Wed, 17 Jan 2024 18:25:18 +0530 Subject: [PATCH 1/4] feat: update file feature_toggle_annotations.yaml --- .../contrib/config/feature_toggle_annotations.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/code_annotations/contrib/config/feature_toggle_annotations.yaml b/code_annotations/contrib/config/feature_toggle_annotations.yaml index 2860517..ae63dc4 100644 --- a/code_annotations/contrib/config/feature_toggle_annotations.yaml +++ b/code_annotations/contrib/config/feature_toggle_annotations.yaml @@ -25,3 +25,17 @@ extensions: python: - py rst_template: doc.rst.j2 + +# .. toggle_name: SOME_FEATURE_NAME +# .. toggle_implementation: WaffleFlag OR WaffleSwitch OR CourseWaffleFlag OR ExperimentWaffleFlag OR ConfigurationModel OR SettingToggle OR SettingDictToggle OR DjangoSetting +# .. toggle_default: True OR False +# .. toggle_description: Add here a detailed description of the consequences of enabling this feature toggle. +# Note that all annotations can be spread over multiple lines by prefixing every line after the first by +# at least three spaces (two spaces plus the leading space). +# .. toggle_warning: (Optional) Add here additional instructions that users should be aware of. For instance, dependency +# on additional settings or feature toggles should be referenced here. If this field is not needed, simply remove it. +# .. toggle_use_cases: temporary OR circuit_breaker OR vip OR opt_out OR opt_in OR open_edx +# .. toggle_creation_date: 2020-01-01 +# .. toggle_target_removal_date: 2020-07-01 (this is required if toggle_use_cases includes temporary. If not, simply remove it.) +# .. toggle_tickets: (Optional) https://openedx.atlassian.net/browse/DEPR-xxx, https://github.com/openedx/edx-platform/blob/master/docs/decisions/xxx.rst, https://github.com/openedx/edx-platform/pull/xxx (details initial feature) +SOME_FEATURE_NAME = ... From a7dc3b9377856aea51a77e1a7e4408b3d47f21bb Mon Sep 17 00:00:00 2001 From: Yagnesh Date: Thu, 18 Jan 2024 18:27:48 +0530 Subject: [PATCH 2/4] feat: update feature_toggle_annotations.yaml file --- .../config/feature_toggle_annotations.yaml | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/code_annotations/contrib/config/feature_toggle_annotations.yaml b/code_annotations/contrib/config/feature_toggle_annotations.yaml index ae63dc4..c30aeb8 100644 --- a/code_annotations/contrib/config/feature_toggle_annotations.yaml +++ b/code_annotations/contrib/config/feature_toggle_annotations.yaml @@ -15,8 +15,10 @@ annotations: - ".. toggle_use_cases:": choices: [temporary, circuit_breaker, vip, opt_out, opt_in, open_edx] - ".. toggle_creation_date:": - - ".. toggle_target_removal_date:": + - ".. toggle_removal_ticket:": optional: true + - ".. toggle_target_removal_date:": + optional: true - ".. toggle_warning:": optional: true - ".. toggle_tickets:": @@ -25,17 +27,3 @@ extensions: python: - py rst_template: doc.rst.j2 - -# .. toggle_name: SOME_FEATURE_NAME -# .. toggle_implementation: WaffleFlag OR WaffleSwitch OR CourseWaffleFlag OR ExperimentWaffleFlag OR ConfigurationModel OR SettingToggle OR SettingDictToggle OR DjangoSetting -# .. toggle_default: True OR False -# .. toggle_description: Add here a detailed description of the consequences of enabling this feature toggle. -# Note that all annotations can be spread over multiple lines by prefixing every line after the first by -# at least three spaces (two spaces plus the leading space). -# .. toggle_warning: (Optional) Add here additional instructions that users should be aware of. For instance, dependency -# on additional settings or feature toggles should be referenced here. If this field is not needed, simply remove it. -# .. toggle_use_cases: temporary OR circuit_breaker OR vip OR opt_out OR opt_in OR open_edx -# .. toggle_creation_date: 2020-01-01 -# .. toggle_target_removal_date: 2020-07-01 (this is required if toggle_use_cases includes temporary. If not, simply remove it.) -# .. toggle_tickets: (Optional) https://openedx.atlassian.net/browse/DEPR-xxx, https://github.com/openedx/edx-platform/blob/master/docs/decisions/xxx.rst, https://github.com/openedx/edx-platform/pull/xxx (details initial feature) -SOME_FEATURE_NAME = ... From 5fd1ad331ba98be206a2bdbdb4165987196ddc07 Mon Sep 17 00:00:00 2001 From: Yagnesh Date: Wed, 31 Jan 2024 00:41:20 +0530 Subject: [PATCH 3/4] feat: update CHANGELOG.rst --- CHANGELOG.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index b9a64fb..d19b4f7 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -14,6 +14,10 @@ Change Log Unreleased ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +[1.6.0] - 2024-01-31 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* Added new annotation ``toggle_removal_ticket`` [1.5.0] - 2023-07-21 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 0d8226c35ad843acf3ae38d5006bcbf298078ea2 Mon Sep 17 00:00:00 2001 From: Yagnesh Date: Wed, 31 Jan 2024 01:34:02 +0530 Subject: [PATCH 4/4] feat: update version --- code_annotations/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code_annotations/__init__.py b/code_annotations/__init__.py index 1b5ed55..5089f01 100644 --- a/code_annotations/__init__.py +++ b/code_annotations/__init__.py @@ -2,4 +2,4 @@ Extensible tools for parsing annotations in codebases. """ -__version__ = '1.5.0' +__version__ = '1.6.0'