@@ -77,25 +77,23 @@ example process is provided below. The first step is the key entry point.
77
77
78
78
1 . Run the following command to start the interactive update process.
79
79
80
- ``` sh
81
- bundle exec rails app:update
82
- ```
80
+ ``` sh
81
+ bundle exec rails app:update
82
+ ```
83
83
84
84
1. Accept all the changes with ` a` .
85
-
86
85
> You can alternatively review each individual change via the interactive
87
86
> update process if you' re comfortable reviewing and making decisions on
88
87
> diffs in the command line. It' s a similar interface to ` git add --patch` .
89
88
90
89
1. Run Rubocop to bring the code changes in line with our formatting/linting
91
90
standards (and remove superficial changes from the diff).
92
91
93
- ``` sh
94
- bundle exec rubocop --autocorrect
95
- ```
92
+ ` ` ` sh
93
+ bundle exec rubocop --autocorrect
94
+ ` ` `
96
95
97
96
1. Review the diff and decide which changes to accept and commit.
98
-
99
97
> The changes that get suggested by the update task will vary between apps.
100
98
> They are based on a few settings, including which railties and engines are
101
99
> enabled in ` config/application.rb` and whether ` config.api_only` is set to
@@ -105,11 +103,11 @@ example process is provided below. The first step is the key entry point.
105
103
appropriate version-specific guide) and in the commit message, following the
106
104
[GDS guidance on commit messages][].
107
105
108
- Even if your decision is to accept a default, it's useful to know whether
109
- you're just opting into a new default in the absence of a strong opinion, or
110
- if you think the new setting is important and should be retained in future
111
- upgrades. Documenting this will make decisions easier when performing future
112
- upgrades.
106
+ Even if your decision is to accept a default, it' s useful to know whether
107
+ you' re just opting into a new default in the absence of a strong opinion, or
108
+ if you think the new setting is important and should be retained in future
109
+ upgrades. Documenting this will make decisions easier when performing future
110
+ upgrades.
113
111
114
112
[GDS guidance on commit messages]:
115
113
https://gds-way.digital.cabinet-office.gov.uk/standards/source-code/working-with-git.html#commit-messages
@@ -125,19 +123,18 @@ guidance][] that follows.
125
123
- For changes to settings in `config/environment`, work out if we were using a
126
124
previous Rails default.
127
125
128
- If we weren't using a previous Rails default, look for an explanation in the
129
- app's git history.
130
-
131
- If we were using a previous Rails default, consult the following to inform
132
- your decision on whether to move to the new default:
126
+ If we weren' t using a previous Rails default, look for an explanation in the
127
+ app' s git history.
133
128
134
- - [ GOV.UK Helm Charts] [ ] - does the config change affect an environment
129
+ If we were using a previous Rails default, consult the following to inform
130
+ your decision on whether to move to the new default:
131
+ - [GOV.UK Helm Charts][] - does the config change affect an environment
135
132
variable that we' ve set for the app?
136
- - The app’s git history
137
- - [ Rails version-specific guidance] [ official Rails guidance ]
138
- - [ Rails source code] [ ] and git history related to the change
139
- - [ Rails change log] [ ] for the given release
140
- - [ Rails configuration documentation] [ ]
133
+ - The app’s git history
134
+ - [Rails version-specific guidance][official Rails guidance]
135
+ - [Rails source code][] and git history related to the change
136
+ - [Rails change log][] for the given release
137
+ - [Rails configuration documentation][]
141
138
142
139
- For changes in ` public/* ` , in general you can leave out HTML and image files
143
140
(and consider removing any existing ones). We serve our own error pages and
0 commit comments