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