Merge pull request #33308 from anniecodes/notes-command-changelog

Add rake notes and SOURCE_ANNOTATION_DIRECTORIES deprecation to Changelog

1 files changed, 19 insertions, 0 deletions

diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md
index 83a57a8c6a..81cb5a6c9f 100644
--- a/railties/CHANGELOG.md
+++ b/railties/CHANGELOG.md
@@ -1,3 +1,22 @@
+*   Deprecate `rails notes` subcommands in favor of passing an `annotations` argument to `rails notes`.
+
+    The following subcommands are replaced by passing `--annotations` or `-a` to `rails notes`:
+        - `rails notes:custom ANNOTATION=custom` is deprecated in favor of using `rails notes -a custom`.
+        - `rails notes:optimize` is deprecated in favor of using `rails notes -a OPTIMIZE`.
+        - `rails notes:todo` is deprecated in favor of  using`rails notes -a TODO`.
+        - `rails notes:fixme` is deprecated in favor of using `rails notes -a FIXME`.
+
+    *Annie-Claude Côté*
+
+*   Deprecate `SOURCE_ANNOTATION_DIRECTORIES` environment variable used by `rails notes`
+    through `Rails::SourceAnnotationExtractor::Annotation` in favor of using `config.annotations.register_directories`.
+
+    *Annie-Claude Côté*
+
+*   Deprecate `rake notes` in favor of `rails notes`.
+
+    *Annie-Claude Côté*
+
 *   Don't generate unused files in `app:update` task
 
      Skip the assets' initializer when sprockets isn't loaded.