ff83b39ee46bb146c552ce39f42bb105d562dc00
[ikiwiki.git] / docs / developer / Release / index.mdwn
1 #The art of releasing
2
3 This is a template on how to do a release.
4
5 ##Branching
6
7 On crater branch the repo:
8
9     cd /repository/git/dragonfly.git
10     git branch DragonFly_RELEASE_x_y        (e.g. 2_8)
11
12 This is the only step that needs to happen remotely.
13
14 On your own system:
15
16 Check out two copies of /usr/src, one with master checked out, one with the new release branch checked out.  Checkouts should be under your user id, NOT as root, or the later tagging operation will be unhappy.
17
18     mkdir master
19     cd master
20     git init
21     git remote add origin ssh://crater.dragonflybsd.org/repository/git/dragonfly.git
22     git fetch origin
23
24     cd ..
25     cp -R master x_y 
26     # x_y is the release; faster than rechecking out
27     cd master
28     git checkout master
29     cd ..
30     cd ../x_y/
31     git branch DragonFly_RELEASE_x_y origin/DragonFly_RELEASE_x_y
32     git checkout DragonFly_RELEASE_x_y 
33
34 On the new branch:
35
36     vi sys/sys/param.h      
37
38 Edit \__DragonFly\_version and related comments.  You only need to add a commented version number for the branch, not the new master.
39
40     vi sys/conf/newvers.sh  
41
42 Edit BRANCH, use 'RELEASE', update version.  e.g. RELEASE_2_8
43
44     vi gnu/usr.bin/groff/tmac/mdoc.local
45
46 In the "Default .Os value" section, bump up the version to that of the release (even minor number).
47
48 Adjust the default src checkout in /usr/src/etc/Makefile.usr to pull this branch.  Otherwise, anyone using the Makefile to download source will get master, and nrelease will build master.
49
50 On master:
51
52     vi sys/sys/param.h
53
54 Edit \__DragonFly\_version and related comments.  Put in commented numbers for the new release and master.
55
56     vi sys/conf/newvers.sh  
57
58 Edit BRANCH, use 'DEVELOPMENT', update version.
59
60     vi gnu/usr.bin/groff/tmac/mdoc.local
61
62 In the "Default .Os value" section, bump up the version to that of the master (odd minor number). Additionally, in the "DragonFly releases not found in doc-common" section, add a new line (a la the previous ones) for the new master.
63
64 ##Tagging
65
66 Make sure all changes on the master branch **and** on the new branch have been committed and pushed before tagging anything.
67
68     git add sys/sys/param.h sys/conf/newvers.sh gnu/usr.bin/groff/tmac/mdoc.local
69     git commit
70     git push
71
72 man git-tag for info, the committer needs GPG set up so git tag -s works.  Then you can use your own checkout.  Be sure the checkouts are under your user id and you do the tagging as yourself instead of as root.
73
74 ###In master
75
76     git tag -s -m "DragonFly x.x.0" vx.x.0
77     git push --tags
78
79 ###In the new branch
80
81     git tag -s -m "DragonFly x.y.0" vx.y.0
82     git push --tags
83
84 Do the x.x.0 immediately.  Just before doing the final nrelease build roll a x.x.1 tag for the release branch.  Release as x.x.1.
85
86 A new tag may require a commit beforehand to the release branch to make sure it goes to the right branch.
87
88 ## Subsequent tag updates
89
90 When updating a x.x.1 version, you just need to tag.
91
92 ## Something in GCC
93
94 The file gnu/usr.bin/cc41/cc_prep/config/dragonfly.h has a spot where the major version number for DragonFly is encoded.  I don't know if this applies for anything other than gcc 4.1.
95
96     #define        DFBSD_MAJOR     3
97
98 This comes from John Marino's commit:
99
100 <http://gitweb.dragonflybsd.org/dragonfly.git/commitdiff/43add724990da155c21ef4a0893f4ebc2c36eb05>
101
102 ##Pkgsrc 
103
104 Adjust bulk builds to the release's pkgsrc branch, and make sure they upload to the right directories on avalon.dragonflybsd.org.
105
106 Adjust the default pkgsrc checkout in /usr/src/etc/Makefile.usr for both master and the new branch if necessary.
107
108 ###build isos and imgs
109
110
111
112 ###build pkgsrc packages
113
114 ###Testing
115
116 Testing should be done on real hardware, qemu and vmware. We have six isos/imgs that needs testing.
117
118 i386 iso, img, gui-img<br/>
119 x86_64 iso, img, gui-img
120
121 Test this:
122
123 * Booting install media.
124 * Installing; encrypted, unencrypted, ufs, hammer.
125 * Configuring everything in the installer; try both dhcp and static IP.
126 * Booting the installed system.
127
128 ###Release Notes
129
130 Copy one of the existing release pages.  The general format is :
131
132 * General announcement
133 * Big items new to this release
134 * Availability, describing what can be run
135 * MD5 results for compressed and uncompressed files
136 * Special notes and caveats
137 * Release notes - go through git log for these.
138
139 #### Minor releases
140
141 * Update the release page, the main page, and the general [[Download]] page.
142 * Add new MD5 sums on the release page for the compressed and uncompressed files.
143
144 ###File Copy
145
146 Place images in /ftp/iso-images on crater.dragonflybsd.org.  They will be rsynced to mirror-master.
147
148 The file md5.txt should have the md5 output for all the compressed files.  It should also have the md5 output for the uncompressed images, so don't just 'md5 *bz2 > md5.txt'; get that separately and copy it into the document.
149
150 ###announce
151 users@, web page