Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 231 lines (149 sloc) 7.408 kB
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
1 = Releasing Rails
2
3 In this document, we'll cover the steps necessary to release Rails. Each
4 section contains steps to take during that time before the release. The times
5 suggested in each header are just that: suggestions. However, they should
6 really be considered as minimums.
7
8 == 10 Days before release
9
10 Today is mostly coordination tasks. Here are the things you must do today:
11
12 === Is the CI green? If not, make it green. (See "Fixing the CI")
13
14 Do not release with a Red CI. You can find the CI status here:
15
16 http://travis-ci.org/#!/rails/rails
17
18 === Is Sam Ruby happy? If not, make him happy.
19
20 Sam Ruby keeps a test suite that makes sure the code samples in his book (Agile
21 Web Development with Rails) all work. These are valuable integration tests
22 for Rails. You can check the status of his tests here:
23
24 http://intertwingly.net/projects/dashboard.html
25
26 Do not release with Red AWDwR tests.
27
28 === Do we have any git dependencies? If so, contact those authors.
29
30 Having git dependencies indicates that we depend on unreleased code.
31 Obviously rails cannot be released when it depends on unreleased code.
32 Contact the authors of those particular gems and work out a release date that
f566fb3 @waynn "suits" is correct here, not "suites"
waynn authored
33 suits them.
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
34
5399b20 @tenderlove moving CI and Sam Ruby to the top of the list. I :heart: CI and Sam
tenderlove authored
35 === Contact the security team (either Koz or tenderlove)
36
37 Let them know of your plans to release. There may be security issues to be
38 addressed, and that can impact your release date.
39
40 === Notify implementors.
41
42 Ruby implementors have high stakes in making sure Rails works. Be kind and
43 give them a heads up that Rails will be released soonish.
44
45 Send an email just giving a heads up about the upcoming release to these
46 lists:
47
48 * team@jruby.org
49 * community@rubini.us
50 * rubyonrails-core@googlegroups.com
51
52 Implementors will love you and help you.
53
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
54 == 3 Days before release
55
56 This is when you should release the release candidate. Here are your tasks
57 for today:
58
59 === Is the CI green? If not, make it green.
60
61 === Is Sam Ruby happy? If not, make him happy.
62
63 === Contact the security team. CVE emails must be sent on this day.
64
65 === Create a release branch.
66
67 From the stable branch, create a release branch. For example, if you're
68 releasing Rails 3.0.10, do this:
69
70 [aaron@higgins rails (3-0-stable)]$ git checkout -b 3-0-10
71 Switched to a new branch '3-0-10'
72 [aaron@higgins rails (3-0-10)]$
73
74 === Update each CHANGELOG.
75
76 Many times commits are made without the CHANGELOG being updated. You should
77 review the commits since the last release, and fill in any missing information
78 for each CHANGELOG.
79
80 You can review the commits for the 3.0.10 release like this:
81
82 [aaron@higgins rails (3-0-10)]$ git log v3.0.9..
83
c7b8468 @jonleighton Add note about syncing CHANGELOGs
jonleighton authored
84 If you're doing a stable branch release, you should also ensure that all of
85 the CHANGELOG entries in the stable branch are also synced to the master
86 branch.
87
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
88 === Update the RAILS_VERSION file to include the RC.
89
be777b3 @jonleighton Add a note to REALEASING_RAILS about testing the gem locally before r…
jonleighton authored
90 === Build and test the gem.
91
92 Run `rake install` to generate the gems and install them locally. Then try
93 generating a new app and ensure that nothing explodes.
94
6fc2e12 @htanata Some fixes on RELEASING_RAILS.rdoc.
htanata authored
95 This will stop you from looking silly when you push an RC to rubygems.org and
96 then realise it is broken.
be777b3 @jonleighton Add a note to REALEASING_RAILS about testing the gem locally before r…
jonleighton authored
97
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
98 === Release the gem.
99
100 IMPORTANT: Due to YAML parse problems on the rubygems.org server, it is safest
101 to use Ruby 1.8 when releasing.
102
103 Run `rake release`. This will populate the gemspecs with data from
104 RAILS_VERSION, commit the changes, tag it, and push the gems to rubygems.org.
105 Here are the commands that `rake release` should use, so you can understand
106 what to do in case anything goes wrong:
107
108 $ rake all:build
109 $ git commit -am'updating RAILS_VERSION'
110 $ git tag -m'tagging rc release' v3.0.10.rc1
5852fcf @spastorino Add git push and git push --tags to RELEASING_RAILS.rdoc
spastorino authored
111 $ git push
112 $ git push --tags
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
113 $ for i in $(ls dist); do gem push $i; done
114
115 === Send Rails release announcements
116
117 Write a release announcement that includes the version, changes, and links to
118 github where people can find the specific commit list. Here are the mailing
119 lists where you should announce:
120
121 * rubyonrails-core@googlegroups.com
122 * rubyonrails-talk@googlegroups.com
123 * ruby-talk@ruby-lang.org
124
125 Use markdown format for your announcement. Remember to ask people to report
126 issues with the release candidate to the rails-core mailing list.
127
886d011 @tenderlove fixing wrong words. thanks @jbrown
tenderlove authored
128 IMPORTANT: If any users experience regressions when using the release
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
129 candidate, you *must* postpone the release. Bugfix releases *should not*
130 break existing applications.
131
132 === Post the announcement to the Rails blog.
133
134 If you used markdown format for your email, you can just paste it in to the
135 blog.
136
137 * http://weblog.rubyonrails.org
138
139 === Post the announcement to the Rails twitter account.
140
141 == Time between release candidate and actual release
142
143 Check the rails-core mailing list and the github issue list for regressions in
144 the RC.
145
146 If any regressions are found, fix the regressions and repeat the release
147 candidate process. We will not release the final until 72 hours after the
148 last release candidate has been pushed. This means that if users find
149 regressions, the scheduled release date must be postponed.
150
151 When you fix the regressions, do not create a new branch. Fix them on the
152 stable branch, then cherry pick the commit to your release branch. No other
153 commits should be added to the release branch besides regression fixing commits.
154
155 == Day of release
156
157 Many of these steps are the same as for the release candidate, so if you need
158 more explanation on a particular step, so the RC steps.
159
22e611e @tenderlove making the order more clear, adding linux distros mailing lists to ou…
tenderlove authored
160 Today, do this stuff in this order:
161
162 * Apply security patches to the release branch
163 * Update CHANGELOG with security fixes.
164 * Update RAILS_VERSION to remove the rc
be777b3 @jonleighton Add a note to REALEASING_RAILS about testing the gem locally before r…
jonleighton authored
165 * Build and test the gem
22e611e @tenderlove making the order more clear, adding linux distros mailing lists to ou…
tenderlove authored
166 * Release the gems
167 * Email security lists
168 * Email general announcement lists
9d9f591 @tenderlove adding lessons learned so I do not make the same mistake twice
tenderlove authored
169
22e611e @tenderlove making the order more clear, adding linux distros mailing lists to ou…
tenderlove authored
170 === Emailing the rails security announce list
9d9f591 @tenderlove adding lessons learned so I do not make the same mistake twice
tenderlove authored
171
22e611e @tenderlove making the order more clear, adding linux distros mailing lists to ou…
tenderlove authored
172 Email the security announce list once for each vulnerability fixed.
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
173
174 You can do this, or ask the security team to do it.
175
22e611e @tenderlove making the order more clear, adding linux distros mailing lists to ou…
tenderlove authored
176 Email the security reports to:
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
177
22e611e @tenderlove making the order more clear, adding linux distros mailing lists to ou…
tenderlove authored
178 * rubyonrails-security@googlegroups.com
179 * linux-distros@vs.openwall.org
6b80917 @tenderlove adding my brain dump of the release process
tenderlove authored
180
181 Be sure to note the security fixes in your announcement along with CVE numbers
182 and links to each patch. Some people may not be able to upgrade right away,
183 so we need to give them the security fixes in patch form.
184
185 * Blog announcements
186 * Twitter announcements
187 * Merge the release branch to the stable branch.
188 * Drink beer (or other cocktail)
189
190 == Misc
191
192 === Fixing the CI
193
194 There are two simple steps for fixing the CI:
195
196 1. Identify the problem
197 2. Fix it
198
199 Repeat these steps until the CI is green.
307fc12 @fxn release instructions: new section about docs generation
fxn authored
200
201 === Manually trigger docs generation
202
203 We have a post-receive hook in GitHub that calls the docs server on pushes.
6fc2e12 @htanata Some fixes on RELEASING_RAILS.rdoc.
htanata authored
204 It triggers generation and publication of edge docs, updates the contrib app,
307fc12 @fxn release instructions: new section about docs generation
fxn authored
205 and generates and publishes stable docs if a new stable tag is detected.
206
207 The hook unfortunately is not invoked by tag pushing, so once the new stable
208 tag has been pushed to origin, please run
209
c2aadf8 @fxn updates the host and port of publish_docs, and changes the release in…
fxn authored
210 rake publish_docs
307fc12 @fxn release instructions: new section about docs generation
fxn authored
211
212 You should see something like this:
213
214 Rails master hook tasks scheduled:
215
216 * updates the local checkout
217 * updates Rails Contributors
218 * generates and publishes edge docs
219
220 If a new stable tag is detected it also
221
222 * generates and publishes stable docs
223
224 This needs typically a few minutes.
225
226 Note you do not need to specify the tag, the docs server figures it out.
227
228 Also, don't worry if you call that multiple times or the hook is triggered
229 again by some immediate regular push, if the scripts are running new calls
230 are just queued (in a queue of size 1).
Something went wrong with that request. Please try again.