8ddbfcdbb3bcdb22a077d41f47f088a915ef80f3
[olsrd.git] / release-howto.txt
1 cheat sheet for making a (stable) release tarball.
2
3 0. check if your name settings in .hgrc are correct. (have
4    your real name and email address in there).
5
6 1. clone a fresh tree:
7
8    $ hg clone http://gredler.at/hg/olsrd-0.5.7
9    $ hg update -C OLSRD_0_5_7_BRANCH
10
11 2. check if the DEBUG settings in Makefile.inc are correct:
12
13    DEBUG ?= 0
14    REMOVE_LOG_DEBUG ?= 0
15    REMOVE_LOG_INFO  ?= 0
16    REMOVE_LOG_WARN  ?= 0
17    REMOVE_LOG_ERROR ?= 0
18
19    now check if it builds correct:
20
21    $ make build_all
22
23 3. Change VERS in Makefile.inc to your target release.
24    in this example the target release is 0.5.6-r5
25
26    most likely this is carrying some pre-XXX-release tag.
27    
28    $ grep -E "^VERS" Makefile
29    VERS =          pre-0.5.6-r5
30
31    change it to
32
33    VERS =          0.5.6-r5
34
35 4. commit & push
36
37 5. display the used tags: 
38    
39    $ hg tags
40    tip                             1757:77e1ccb98227
41    OLSRD_0_5_6_R3                  1728:feb3d7883ff0
42    OLSRD_0_5_6_R2                  1688:1573e530a679
43    OLSRD_0_5_6                     1669:d91b47b34ba7
44    OLSRD_0_5_6_RC7                 1644:1516480b552f
45    OLSRD_0_5_6_RC6                 1634:f1b2cdeafd74
46    OLSRD_0_5_6_RC5                 1622:99b89bb6a9a4
47    OLSRD_0_5_6_RC4                 1612:0490bdcb7910
48    OLSRD_0_5_6_RC3                 1591:c6c9571fe4d6
49    OLSRD_0_5_6_RC2                 1587:bd66c98dc4c8
50    OLSRD_0_5_6_RC1                 1526:fd8f4e49a398
51    OLSRD_0_5_5                     1460:233036647bca
52    OLSRD_0_5_5_RC1                 1452:669b81f6918e
53    OLSRD_0_5_4                     1264:60f04fc39707
54    OLSRD_0_5_3                     1158:00991ca84047
55    OLSRD_0_5_2                     1121:283effb1472c
56    OLSRD_0_5_1                     1101:c23aab9db1e1
57    OLSRD_0_5_0                      994:612f5a21a303
58    OLSRD_0_4_10                     893:a39cda38836b
59    OLSRD_0_4_9                      704:43d67c4814ef
60    OLSRD_0_4_8                      404:e9beaf82c0ea
61
62    now tag the tree (please stick to the tagging scheme).
63
64    $ hg tag OLSRD_0_5_6_R5
65
66 6. make the release tarball
67
68    $ cd scripts/
69    $ ./mk-tarball.sh
70    [ ... ]
71    ### creating /tmp/olsrd-0.5.6-r5.tar.gz
72    6c996e94de06115d19dbbcaf6847051a  /tmp/olsrd-0.5.6-r5.tar.gz
73    ### creating /tmp/olsrd-0.5.6-r5.tar.bz2
74    e476819be5747758e3d6f579e4096bce  /tmp/olsrd-0.5.6-r5.tar.bz2
75
76 7. check if everything is in the release tarball (ideally on a a
77    differnt machine) and try to build from the tarball.
78
79 8. upload the the .tgz and .bz2 tarballs to the http://www.olsr.org/downaload/0.5/
80    sectaion and add a release articel on the web.
81
82 9. Change VERS in Makefile.inc to your *next* target release.
83    in this example the next target release is pre-0.5.6-r6
84
85    change it from:
86    
87    $ grep -E "^VERS" Makefile
88    VERS =          0.5.6-r5
89
90    to
91
92    VERS =          pre-0.5.6-r6
93
94    commit & push
95
96 you are done, congratulations !