author | Tom Henderson <tomh@tomh.org> |
Mon, 07 Apr 2008 21:35:54 -0700 | |
changeset 2892 | b17f2928291e |
parent 2891 | aeca90b95bf5 |
child 3194 | 79dba133b5f8 |
permissions | -rw-r--r-- |
776 | 1 |
Steps in doing an ns-3 release |
2 |
||
1789
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
3 |
0. check out a clean ns-3-dev somewhere |
776 | 4 |
1. prepare the source files |
5 |
- revise and check in AUTHORS, if needed |
|
6 |
- revise and check in RELEASE_NOTES |
|
7 |
- update and check in VERSION to the latest release number |
|
1797
7cd3c92af131
Add Doxygen cleanup as a release step
Tom Henderson <tomh@tomh.org>
parents:
1789
diff
changeset
|
8 |
- confirm that Doxygen builds cleanly and without warnings |
7cd3c92af131
Add Doxygen cleanup as a release step
Tom Henderson <tomh@tomh.org>
parents:
1789
diff
changeset
|
9 |
(./waf --doxygen), and check in any necessary changes |
2194 | 10 |
2. ./waf configure; ./waf dist |
1789
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
11 |
- this will create a ns-3.0.x.tar.bz2 tarball |
2892
b17f2928291e
note that waf generates reference trace tarball now
Tom Henderson <tomh@tomh.org>
parents:
2891
diff
changeset
|
12 |
- this will also create a ns-3.0.x-ref-traces.tar.bz2 tarball |
2194 | 13 |
3. test tarball on release platforms (waf check and maybe some other scripts) |
14 |
4. once you are happy with the tarball, tag ns-3-dev with "release ns-3.0.X" |
|
1789
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
15 |
- hg tag "release ns-3.0.x" |
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
16 |
- hg push |
2194 | 17 |
5. clone the tagged ns-3-dev and place it on the repository |
2343
85959d329c8c
a few tweaks to the release steps document
Tom Henderson <tomh@tomh.org>
parents:
2194
diff
changeset
|
18 |
- ssh code.nsnam.org; sudo tcsh; su code; |
1789
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
19 |
- cp -r /home/code/repos/ns-3-dev /home/code/repos/ns-3.0.x |
2194 | 20 |
- cd /home/code/repos/ns-3.0.x/.hg and edit the hgrc appropriately: |
21 |
"description = ns-3.0.x release |
|
22 |
name = ns-3.0.x" |
|
2865
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
23 |
6. Run the regression tests on the new release and update the reference traces |
2891 | 24 |
- ./waf --regression |
25 |
- ./waf --valgrind --regression (for valgrind version) |
|
2865
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
26 |
- There should be no regressions at this time |
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
27 |
- tag ns-3-dev-ref-traces with "release ns-3.0.X" |
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
28 |
hg tag "release ns-3.0.x" |
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
29 |
hg push |
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
30 |
- clone the ns-3-dev-ref-traces and place it on the repository as in step |
2891 | 31 |
5 but use the name ns-3.0.x-ref-traces |
2865
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
32 |
7. Create a reference traces tarball |
2892
b17f2928291e
note that waf generates reference trace tarball now
Tom Henderson <tomh@tomh.org>
parents:
2891
diff
changeset
|
33 |
- again, run "./waf dist" |
2865
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
34 |
8. upload "ns-3.0.x.tar.bz2" to the /var/www/html/releases/ directory on |
1789
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
35 |
the www.nsnam.org server |
2343
85959d329c8c
a few tweaks to the release steps document
Tom Henderson <tomh@tomh.org>
parents:
2194
diff
changeset
|
36 |
- give it 644 file permissions, and user/group = apache |
2865
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
37 |
9. upload "ns-3.0.x-ref-traces.tar.bz2" to the /var/www/html/releases/ |
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
38 |
directory on the www.nsnam.org server |
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
39 |
- give it 644 file permissions, and user/group = apache |
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
40 |
10. update web pages on www.nsnam.org (source is in the www/ module) |
776 | 41 |
- add link to news.html |
1789
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
42 |
- update getting_started.html |
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
43 |
- update documents.html |
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
44 |
- update roadmap on wiki |
776 | 45 |
- build and update Doxygen directory on the server |
1789
39a56c382884
more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents:
1286
diff
changeset
|
46 |
-- ssh www.nsnam.org; sudo tcsh; su nsnam; |
2194 | 47 |
-- edit ~/bin/update-doxygen-release file and change RELEASE variable |
48 |
to the right version number |
|
49 |
-- run ~/bin/update-doxygen-release |
|
2865
d40eb18a4da0
Point regression tests to final locations, update release steps, bug 158
Craig Dowell <craigdo@ee.washington.edu>
parents:
2343
diff
changeset
|
50 |
11. announce to ns-developers, with summary of release notes |