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