doc/release_steps.txt
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Tue, 06 Nov 2007 16:16:18 +0100
changeset 2084 24cfc21bda99
parent 1797 7cd3c92af131
child 2194 25bad6958d13
permissions -rw-r--r--
use the holland set of modes.
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 
776
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
2. make a new "architecture.pdf" document and place it in the doc/ directory
1789
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    11
   of the ns-3-dev working directory
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    12
3. ./waf configure; ./waf dist
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    13
   - this will create a ns-3.0.x.tar.bz2 tarball
1286
4b90ad2ff1a0 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 932
diff changeset
    14
4. test tarball on release platforms (waf check and maybe some other scripts)
1789
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    15
5. once you are happy with the tarball, tag ns-3-dev with "release ns-3.0.X"
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    16
   - hg tag "release ns-3.0.x"
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    17
   - hg push 
1286
4b90ad2ff1a0 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 932
diff changeset
    18
6. clone the tagged ns-3-dev and place it on the repository
1789
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    19
   - ssh code.nsnam.org; sudo; su code;
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    20
   - cp -r /home/code/repos/ns-3-dev /home/code/repos/ns-3.0.x
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    21
   - cd /home/code/repos/ns-3.0.x/.hg and edit the hgrc appropriately
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    22
7. upload "ns-3.0.x.tar.bz2" to the /var/www/html/releases/ directory on 
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    23
   the www.nsnam.org server
1286
4b90ad2ff1a0 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 932
diff changeset
    24
8. update web page
776
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
   - add link to news.html
1789
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    26
   - update getting_started.html
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    27
   - update documents.html
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    28
   - update roadmap on wiki
776
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    29
   - 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
    30
     -- ssh www.nsnam.org; sudo tcsh; su nsnam;
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    31
     -- ~/bin/update-doxygen-release
776
34d5715456b3 release_steps.txt document
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
   - update and upload software architecture document (PDF, HTML)
1789
39a56c382884 more detail in release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 1286
diff changeset
    33
     -- note:  HTML image generation is not currently automatic
1286
4b90ad2ff1a0 update release_steps.txt
Tom Henderson <tomh@tomh.org>
parents: 932
diff changeset
    34
9. announce to ns-developers, with summary of release notes