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