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