doc/release_steps.txt
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 17 Apr 2008 15:40:25 -0700
changeset 2971 75780f899be3
parent 2892 b17f2928291e
child 3194 79dba133b5f8
permissions -rw-r--r--
output the initial value of the attributes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
776
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
Steps in doing an ns-3 release
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     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
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
1. prepare the source files
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
   - revise and check in AUTHORS, if needed
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
   - revise and check in RELEASE_NOTES
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     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
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    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
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    13
3. test tarball on release platforms (waf check and maybe some other scripts)
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    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
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    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
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    20
   - cd /home/code/repos/ns-3.0.x/.hg and edit the hgrc appropriately:
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    21
     "description = ns-3.0.x release
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    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
aeca90b95bf5 nits for 3.0.12 release
Tom Henderson <tomh@tomh.org>
parents: 2865
diff changeset
    24
   - ./waf --regression
aeca90b95bf5 nits for 3.0.12 release
Tom Henderson <tomh@tomh.org>
parents: 2865
diff changeset
    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
aeca90b95bf5 nits for 3.0.12 release
Tom Henderson <tomh@tomh.org>
parents: 2865
diff changeset
    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
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    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
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    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
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    47
     -- edit ~/bin/update-doxygen-release file and change RELEASE variable 
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    48
        to the right version number 
25bad6958d13 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1797
diff changeset
    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