aboutsummaryrefslogtreecommitdiffstats
path: root/railties
diff options
context:
space:
mode:
authorAnnie-Claude Côté <hello@annie.codes>2018-07-06 10:21:07 -0400
committerAnnie-Claude Côté <hello@annie.codes>2018-07-09 11:20:28 -0400
commita028d3f7754f64d27119c57dda288804371b74fc (patch)
treef7602f5dcc156800c44682dda89aed8f11989ffb /railties
parenta0061d2389a178b093f0d3f64f58236ffbe088e0 (diff)
downloadrails-a028d3f7754f64d27119c57dda288804371b74fc.tar.gz
rails-a028d3f7754f64d27119c57dda288804371b74fc.tar.bz2
rails-a028d3f7754f64d27119c57dda288804371b74fc.zip
Add deprecations related to `rails notes` command to Changelog
* SOURCE_ANNOTATION_DIRECTORIES deprecation * Deprecation of `rake notes`, use `rails notes` instead * Deprecation of `rails notes:custom ANNOTATION=custom`, `rails notes:optimize`, `rails notes:todo`, and `rails notes:fixme` in favor of passing `-annotations` or `-a` to `rails notes` * They have all been deprecrated in https://github.com/rails/rails/pull/33220
Diffstat (limited to 'railties')
-rw-r--r--railties/CHANGELOG.md19
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.