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