[BD-21] Update feature toggle annotation config

The following changes are made to the feature toggle annotation config: 1. the `toggle_category` annotation is deprecated 2. the list of `toggle_use_cases` is simplified 3. the `toggle_status` field is deprecated 4. `toggle_expiration_date` was renamed to `toggle_target_removal_date` 5. Add SettingToggle, SettingDictToggle toggle implementations OEP-17 will be updated correspondingly.
openedx · Sep 8, 2020 · fa1f5b0 · fa1f5b0
1 parent eba1ecd
commit fa1f5b0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -11,6 +11,11 @@ Change Log
 
 .. There should always be an "Unreleased" section for changes pending release.
 
+[0.7.0] - 2020-09-07
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Simplify the feature toggle annotation format
+
 [0.6.0] - 2020-08-27
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/code_annotations/__init__.py b/code_annotations/__init__.py
@@ -2,4 +2,4 @@
 Extensible tools for parsing annotations in codebases.
 """
 
-__version__ = '0.6.0'
+__version__ = '0.7.0'
diff --git a/code_annotations/config_and_tools/config/feature_toggle_annotations.yaml b/code_annotations/config_and_tools/config/feature_toggle_annotations.yaml
@@ -11,17 +11,15 @@ annotations:
   feature_toggle:
     - ".. toggle_name:":
     - ".. toggle_implementation:":
-        choices: [ExperimentWaffleFlag, WaffleFlag, WaffleSwitch, CourseWaffleFlag, ConfigurationModel, DjangoSetting]
+        choices: [WaffleFlag, WaffleSwitch, CourseWaffleFlag, ExperimentWaffleFlag, SettingToggle, SettingDictToggle, ConfigurationModel, DjangoSetting]
     - ".. toggle_default:":
     - ".. toggle_description:":
-    - ".. toggle_category:":
     - ".. toggle_use_cases:":
-        choices: [incremental_release, launch_date, monitored_rollout, graceful_degradation, beta_testing, vip, opt_out, opt_in, open_edx]
+        choices: [temporary, circuit_breaker, vip, opt_out, opt_in, open_edx]
     - ".. toggle_creation_date:":
-    - ".. toggle_expiration_date:":
+    - ".. toggle_target_removal_date:":
     - ".. toggle_warnings:":
     - ".. toggle_tickets:":
-    - ".. toggle_status:":
 extensions:
     python:
         - py