better note about __DragonFly_version in tagging.
[ikiwiki.git] / docs / developer / Release / index.mdwn
CommitLineData
86b77dc1 1#The art of releasing
2
3This is a template on how to do a release.
4
ad252dc8 5##Branching
6
7On crater branch the repo:
8
9 cd /repository/git/dragonfly.git
10 git branch DragonFly_RELEASE_x_y (e.g. 2_8)
11
3691609e 12This is the only step that needs to happen remotely.
13
14On your own system:
15
ad252dc8 16Check 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
18On the new branch:
19
20 vi sys/sys/param.h
21
22Edit \__DragonFly\_version and related comments. Be sure to add a comment for the new master too (but the version is set to the new release).
23
24 vi sys/conf/newvers.sh
25
26Edit BRANCH, use 'RELEASE', update version. e.g. RELEASE_2_8
27
28On master
29
30 vi sys/sys/param.h
31
32Edit \__DragonFly\_version and related comments.
33
34 vi sys/conf/newvers.sh
35
36Edit BRANCH, use 'DEVELOPMENT', update version.
37
38##Tagging
39
40Make sure all changes on the master branch and on the new branch have been committed and pushed before tagging anything.
41
42man 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.
43
44###In master
45
46 git tag -s -m "DragonFly 2.x.x" v2.x.x
47 git push --tags
48
49###In the new branch
50
51 git tag -s -m "DragonFly 2.x.x" v2.x.x
52 git push --tags
53
54Do 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.
55
930c5043 56## Subsequent tag updates
57
58When updating a x.x.1 version, you just need to edit sys/sys/param.h in the appropriate branch and then tag.
59
47036946 60\__DragonFly\_version should be set to the appropriate minor number. 300000 changes to 300001, for instance, for 3.0.0 to 3.0.1.
61
bdb68a03 62## Something in GCC
63
64The 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.
65
66 #define DFBSD_MAJOR 3
67
c0808637 68This comes from John Marino's commit:
69
70<http://gitweb.dragonflybsd.org/dragonfly.git/commitdiff/43add724990da155c21ef4a0893f4ebc2c36eb05>
71
ad252dc8 72##Pkgsrc
73
74Adjust bulk builds to the release's pkgsrc branch, and make sure they upload to the right directories on avalon.dragonflybsd.org.
75
76Adjust the default pkgsrc checkout in /usr/src/etc/Makefile.usr for both master and the new branch if necessary.
86b77dc1 77
86b77dc1 78###build isos and imgs
79
d513516b 80
81
86b77dc1 82###build pkgsrc packages
83
c3559da8 84###Testing
86b77dc1 85
c3559da8 86Testing should be done on real hardware, qemu and vmware. We have six isos/imgs that needs testing.
86b77dc1 87
c3559da8 88i386 iso, img, gui-img<br/>
89x86_64 iso, img, gui-img
86b77dc1 90
c3559da8 91Test this:
86b77dc1 92
c3559da8 93* Booting install media.
94* Installing; encrypted, unencrypted, ufs, hammer.
95* Configuring everything in the installer; try both dhcp and static IP.
96* Booting the installed system.
86b77dc1 97
d513516b 98###Release Notes
99
100Copy one of the existing release pages. The general format is :
101
102* General announcement
103* Big items new to this release
104* Availability, describing what can be run
105* MD5 results for compressed and uncompressed files
106* Special notes and caveats
107* Release notes - go through git log for these.
108
94bdda57 109#### Minor releases
110
111* Update the release page, the main page, and the general [[Download]] page.
112* Add new MD5 sums.
113
d513516b 114###File Copy
86b77dc1 115
d513516b 116Place images in /ftp/iso-images on crater.dragonflybsd.org. They will be rsynced to mirror-master.
86b77dc1 117
118###announce
119users@, web page