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