Skip to content

Commit 299900f

Browse files
committed
Edit pass over the railties CHANGELOG
1 parent eccaddb commit 299900f

File tree

1 file changed

+22
-31
lines changed

1 file changed

+22
-31
lines changed

railties/CHANGELOG.md

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
* Ensure only directories exist in Rails default load paths
2-
3-
Previously, some files put under `app` directory would contaminate the load paths.
4-
This commit removes files from the default load paths set up by the Rails framework.
5-
6-
Now, only directories are included as default in the following paths:
7-
8-
* autoload_paths
9-
* autoload_once_paths
10-
* eager_load_paths
11-
* load_paths
1+
* Ensure `autoload_paths`, `autoload_once_paths`, `eager_load_paths`, and
2+
`load_paths` only have directories when initialized from engine defaults.
3+
Previously, files under the `app` directory could end up there too.
124

135
*Takumasa Ochi*
146

@@ -20,59 +12,59 @@
2012

2113
*Takumasa Ochi*
2214

23-
* Use `oven-sh/setup-bun` in GitHub CI when generating an app with bun
15+
* Use `oven-sh/setup-bun` in GitHub CI when generating an app with Bun.
2416

2517
*TangRufus*
2618

27-
* Disable `pidfile` generation in production environment.
19+
* Disable `pidfile` generation in the `production` environment.
2820

2921
*Hans Schnedlitz*
3022

31-
* Set `config.action_view.annotate_rendered_view_with_filenames` to `true` in the
32-
development environment.
23+
* Set `config.action_view.annotate_rendered_view_with_filenames` to `true` in
24+
the `development` environment.
3325

3426
*Adrian Marin*
3527

36-
* Support `BACKTRACE` ENV variable to turn off backtrace cleaning.
28+
* Support the `BACKTRACE` environment variable to turn off backtrace cleaning.
3729

3830
Useful for debugging framework code:
3931

4032
```sh
41-
BACKTRACE=1 ./bin/rails server
33+
BACKTRACE=1 bin/rails server
4234
```
4335

4436
*Alex Ghiculescu*
4537

46-
* Raise `ArgumentError` when reading `config.x.something` with arguments
38+
* Raise `ArgumentError` when reading `config.x.something` with arguments:
4739

4840
```ruby
4941
config.x.this_works.this_raises true # raises ArgumentError
5042
```
5143

5244
*Sean Doyle*
5345

54-
* Add default PWA files for manifest and service-worker that are served from `app/views/pwa` and can be dynamically rendered through erb. Mount these files explicitly at the root with default routes in the generated routes file.
46+
* Add default PWA files for manifest and service-worker that are served from `app/views/pwa` and can be dynamically rendered through ERB. Mount these files explicitly at the root with default routes in the generated routes file.
5547

5648
*DHH*
5749

5850
* Updated system tests to now use headless Chrome by default for the new applications.
5951

6052
*DHH*
6153

62-
* Add GitHub CI files for dependabot, brakeman, rubocop, and running tests by default. Can be skipped with --skip-ci.
54+
* Add GitHub CI files for Dependabot, Brakeman, RuboCop, and running tests by default. Can be skipped with `--skip-ci`.
6355

6456
*DHH*
6557

66-
* Add brakeman gem by default for static analysis of security vulnerabilities. Allow skipping with --skip-brakeman option.
58+
* Add Brakeman by default for static analysis of security vulnerabilities. Allow skipping with `--skip-brakeman option`.
6759

6860
*vipulnsward*
6961

70-
* Add RuboCop with rules from rubocop-rails-omakase by default. Skip with --skip-rubocop.
62+
* Add RuboCop with rules from `rubocop-rails-omakase` by default. Skip with `--skip-rubocop`.
7163

7264
*DHH* and *zzak*
7365

74-
* Use `bin/rails runner --skip-executor` option to not wrap the runner script
75-
with an Executor.
66+
* Use `bin/rails runner --skip-executor` to not wrap the runner script with an
67+
Executor.
7668

7769
*Ben Sheldon*
7870

@@ -82,7 +74,7 @@
8274

8375
*Chedli Bourguiba*
8476

85-
* Fix running `db:system:change` when app has no Dockerfile.
77+
* Fix running `db:system:change` when the app has no Dockerfile.
8678

8779
*Hartley McGuire*
8880

@@ -101,7 +93,7 @@
10193

10294
*Christian Schmidt*
10395

104-
* Enable YJIT by default on new applications running Ruby 3.3+
96+
* Enable YJIT by default on new applications running Ruby 3.3+.
10597

10698
Adds a `config/initializers/enable_yjit.rb` initializer that enables YJIT
10799
when running on Ruby 3.3+.
@@ -119,7 +111,7 @@
119111
* Use numeric UID and GID in Dockerfile template
120112

121113
The Dockerfile generated by `rails new` sets the default user and group
122-
by name instead of UID:GID. This can cause the following error in kubernetes:
114+
by name instead of UID:GID. This can cause the following error in Kubernetes:
123115

124116
```
125117
container has runAsNonRoot and image has non-numeric user (rails), cannot verify user is non-root
@@ -131,13 +123,12 @@
131123

132124
* Disallow invalid values for rails new options.
133125

134-
The `--database`, `--asset-pipeline`, `--css`, and `--javascript` flags for
135-
`rails new` can all take different options. This change adds checks to
136-
options to make sure the user enters the correct value.
126+
The `--database`, `--asset-pipeline`, `--css`, and `--javascript` options
127+
for `rails new` take different arguments. This change validates them.
137128

138129
*Tony Drake*, *Akhil G Krishnan*, *Petrik de Heus*
139130

140-
* Conditionally print `$stdout` when invoking `run_generator`
131+
* Conditionally print `$stdout` when invoking `run_generator`.
141132

142133
In an effort to improve the developer experience when debugging
143134
generator tests, we add the ability to conditionally print `$stdout`

0 commit comments

Comments
 (0)