1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
=head1 release_guide.pod - guide to Rakudo Star releases
Rakudo Star releases are based on Rakudo compiler releases.
Since some time is often needed for module updates and testing
after each Rakudo compiler release, the timing of Star releases
varies from one release to the next.
Also, while the Rakudo compiler issues monthly releases; Star
releases are free to choose a longer release cycle. Star releases
are also free to choose older releases of the compiler, NQP, and/or
Parrot. The goal is to balance end-user stability needs with
progress being made on the compiler, modules, and other runtime
components. Currently Star is on a monthly release cycle; we
expect to slow down to quarterly releases again sometime in 2013.
=head2 Steps to create a release
If this is your first time releasing, B<read the whole guide before
starting>. That way you can ask questions and clear up and confusions before
you're in the thick of it.
If you have done this before, you might want to check for and read any changes
to this release guide since your last run.
Any time this guide tells you to commit changes, you may also push them if you
wish to do so. Step 8 will make sure you do this regardless.
=over 4
=item 1.
Clone the git@github.com:rakudo/star repository.
$ git clone git@github.com:rakudo/star
If you already have clone of rakudo/star, make sure it is in sync
with github:
$ git checkout master
$ git pull origin master
$ git submodule sync
Verify that
$ git status
reports a clean repository.
=item 2.
Change to the star repository directory, and edit the first three
lines of tools/star/Makefile to indicate the desired releases of
Rakudo, NQP, and Parrot to use.
Usually that means the last Rakudo release, the NQP version that is in the
released Rakudo's F<tools/build/NQP_REVISION> file, and the parrot version
in the F<tools/build/PARROT_REVISION> file that is include in the NQP
release.
$ cd star
$ vi tools/star/Makefile
=item 3.
Run "make -f tools/star/Makefile" to populate the star directory
with the needed tarballs and module repositories for building Rakudo Star:
$ make -f tools/star/Makefile
You may at times be prompted for your SSH key/pass combo.
Assuming the Makefile ran successfully, you should now commit your changes.
$ git commit tools
=item 4.
If there are any new modules to be added, use "git submodule" to add
its repo to the modules/ directory. Also add the module directory
name to the modules/MODULES.txt file.
$ git submodule add git@github.com:user/acme-example modules/acme-example
$ echo acme-example >>modules/MODULES.txt
$ git commit . -m "Added acme-example to installed modules."
=item 5.
Verify that all of the git submodules are at the desired commit
for the Star release. To bring all modules up to the current
'master' branch, one can do
# pull master in each submodule dir
$ git submodule foreach git pull origin master
B<ATTENTION!> Currently, the Perl6::MIME::Base64 repo needs to be kept at a
specific commit, due to breakage on Rakudo's part. The above command will have
incorrectly merged commits. To fix this, run these commands from the top of the
star repo:
$ cd modules/Perl6-MIME-Base64
$ git checkout 76fd9decc7c1445390b0ab5a1296e9d244f8e1fd
$ cd -
Then you may commit your update of the submodules:
# commit submodules state to star repo
$ git commit modules
=item 6.
If one doesn't already exist, create a release announcement in
docs/announce/YYYY.MM.md . You can often use the previous release's
file as a starting point, updating the release number, version
information, name, etc. as appropriate. Be sure to pay attention
to any changes listed in Rakudo's ChangeLog.
$ vi docs/announce/YYYY.MM.md
$ git add docs/announce/YYYY.MM.md
$ git commit docs
At this point it is strongly advised that you push your changes so far, to get
feedback on your announcement while you do other steps.
$ git push
=item 7.
Update the release number in the README and Makefile.in files.
$ vi README tools/build/Makefile.in
$ git commit README tools/build/Makefile.in
=item 8.
Make sure any locally modified files have been pushed
back to github.
$ git status
$ git push
=item 9.
Create a candidate release tarball:
$ make -f tools/star/Makefile release VERSION=2012.08
This will create a tarball rakudo-star-2012.08.tar.gz in the
current directory.
=item 10.
Unpack the tarball somewhere else, and do a test build/install:
$ mkdir work
$ cd work
$ tar xvfz ../rakudo-star-2012.08.tar.gz
$ cd rakudo-star-2012.08
$ perl Configure.pl --gen-parrot
$ make install
$ make rakudo-test
$ make rakudo-spectest
$ make modules-test
If there are failures in any of rakudo-test, rakudo-spectest, or
modules-test, then do your best to fix them and return to step 8.
STOP THE RELEASE PROCESS (i.e., do not issue a release) if there
are any errors that you're unable to fix. File issue tickets
(https://github.com/rakudo/star/issues) for failing tests
and report them to #perl6.
=item 11.
Tag the release by its release month ("YYYY.MM").
$ git tag -a -m"tag release YYYY.MM" YYYY.MM # e.g. 2012.08
$ git push --tags
=item 12.
Upload the release tarball to L<http://rakudo.org/downloads/star>:
$ scp rakudo-star-2012.08.tar.gz rakudo@rakudo.org:public_html/downloads/star
If you don't have permission to do this step, please ask one(pmichaud, jnthn,
masak, PerlJam, tadzik, moritz) on #perl6 to do it for you.
=item 13.
Publicize the release in the appropriate places. These include:
=over 4
=item * rakudo.org
=item * perl6-users@perl.org
=item * perl6-language@perl.org
=item * perl6-compiler@perl.org
=item * parrot-users@lists.parrot.org
=item * http://en.wikipedia.org/wiki/Rakudo_Perl_6
=item * http://en.wikipedia.org/wiki/Perl_6
=back
=item 14
Add this release and your name to the list of releases at the end of this
document (F<tools/star/release-guide.pod>).
$ vim tools/star/release-guide.pod
$ git add tools/star/release-guide.pod
$ git commit -m 'note YYYY.MM release in release-guide.pod
=item 15.
You're done! Celebrate with the appropriate amount of fun.
=back
=head2 List of Planned Releases and Release Managers
Release Release manager
======= ===============
2014.01 tadzik
=head2 List of Previous Star Releases
Release Release Manager
======= ===============
2010.07 pmichaud
2010.08 pmichaud
2010.09 pmichaud
2010.10 pmichaud
2010.11 pmichaud
2010.12 pmichaud
2011.01 pmichaud
2011.04 pmichaud
2011.07 pmichaud
2012.01 jnthn
2012.02 jnthn
2012.04 moritz
2012.05 moritz
2012.06 moritz
2012.07 pmichaud
2012.08 pmichaud
2012.09 pmichaud
2012.10 jnthn
2012.11 moritz
2012.12 moritz
2013.01 moritz
2013.02 moritz
2013.05 pmichaud
2013.08 moritz
2013.09 moritz
2013.10 lue
2013.11 moritz
2013.12 lue
=cut
|
