987870fd7213dd9c567516bbe63ef26698589bd7
[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     vi etc/Makefile.usr
49
50 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.
51
52 On master:
53
54     vi sys/sys/param.h
55
56 Edit \__DragonFly\_version and related comments.  Put in commented numbers for the new release and master.
57
58     vi sys/conf/newvers.sh  
59
60 Edit BRANCH, use 'DEVELOPMENT', update version.
61
62     vi gnu/usr.bin/groff/tmac/mdoc.local
63
64 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.
65
66 ##Tagging
67
68 Make sure all changes on the master branch **and** on the new branch have been committed and pushed before tagging anything.
69
70 On release:
71
72     git add sys/sys/param.h sys/conf/newvers.sh gnu/usr.bin/groff/tmac/mdoc.local etc/Makefile.usr
73     git commit
74     git push
75
76 On master:
77
78     git add sys/sys/param.h sys/conf/newvers.sh gnu/usr.bin/groff/tmac/mdoc.local 
79     git commit
80     git push
81
82
83 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.
84
85 ###In master
86
87     git tag -s -m "DragonFly x.x.0" vx.x.0
88     git push --tags
89
90 ###In the new branch
91
92     git tag -s -m "DragonFly x.y.0rc" vx.y.0rc
93     git push --tags
94
95 Do the x.x.0rc immediately.  Just before doing the final nrelease build roll a x.x.0 tag for the release branch - the same method, just without "rc" for release candidate.  Release as x.x.0.
96
97 A new tag may require a commit beforehand to the release branch to make sure it goes to the right branch.
98
99 ## Subsequent tag updates
100
101 When updating a x.x.1 version, you just need to tag.
102
103 ## Something in GCC
104
105 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.
106
107     #define        DFBSD_MAJOR     3
108
109 This comes from John Marino's commit:
110
111 <http://gitweb.dragonflybsd.org/dragonfly.git/commitdiff/43add724990da155c21ef4a0893f4ebc2c36eb05>
112
113 ##Pkgsrc 
114
115 Adjust bulk builds to the release's pkgsrc branch, and make sure they upload to the right directories on avalon.dragonflybsd.org.
116
117 Adjust the default pkgsrc checkout in /usr/src/etc/Makefile.usr for both master and the new branch if necessary.
118
119 ###build isos and imgs
120
121
122
123 ###build pkgsrc packages
124
125 ###Testing
126
127 Testing should be done on real hardware, qemu and vmware. We have six isos/imgs that needs testing.
128
129 i386 iso, img, gui-img<br/>
130 x86_64 iso, img, gui-img
131
132 Test this:
133
134 * Booting install media.
135 * Installing; encrypted, unencrypted, ufs, hammer.
136 * Configuring everything in the installer; try both dhcp and static IP.
137 * Booting the installed system.
138
139 ###Release Notes
140
141 Copy one of the existing release pages.  The general format is :
142
143 * General announcement
144 * Big items new to this release
145 * Availability, describing what can be run
146 * MD5 results for compressed and uncompressed files
147 * Special notes and caveats
148 * Release notes - go through git log for these.
149
150 #### Minor releases
151
152 * Update the release page, the main page, and the general [[Download]] page.
153 * Add new MD5 sums on the release page for the compressed and uncompressed files.
154
155 ###File Copy
156
157 Place images in /ftp/iso-images on crater.dragonflybsd.org.  They will be rsynced to mirror-master.
158
159 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.
160
161 /root/adm/domd5.sh will get the MD5 sums for the compressed and uncompressed images and print them to stdout.
162
163 ###announce
164 users@, web page, Hacker News, Slashdot, Reddit