51b7f5a1ffcf7b1226ae6eb0642879886c6ff87f
[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 On the new branch:
19
20     vi sys/sys/param.h      
21
22 Edit \__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
26 Edit BRANCH, use 'RELEASE', update version.  e.g. RELEASE_2_8
27
28 On master
29
30     vi sys/sys/param.h
31
32 Edit \__DragonFly\_version and related comments.
33
34     vi sys/conf/newvers.sh  
35
36 Edit BRANCH, use 'DEVELOPMENT', update version.
37
38 ##Tagging
39
40 Make sure all changes on the master branch and on the new branch have been committed and pushed before tagging anything.
41
42 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.
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
54 Do 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
56 ##Pkgsrc 
57
58 Adjust bulk builds to the release's pkgsrc branch, and make sure they upload to the right directories on avalon.dragonflybsd.org.
59
60 Adjust the default pkgsrc checkout in /usr/src/etc/Makefile.usr for both master and the new branch if necessary.
61
62 ###build isos and imgs
63
64
65
66 ###build pkgsrc packages
67
68 ###testing
69
70 i386 iso, img, gui-img
71 x86_64 iso, img, gui-img
72
73
74 booting install media
75
76 installing, encrypted, unencrypted, ufs, hammer
77
78 configuring in the installer
79
80 booting installed system
81
82 testing on real hardware, qemu, vmware
83
84 ###Release Notes
85
86 Copy one of the existing release pages.  The general format is :
87
88 * General announcement
89 * Big items new to this release
90 * Availability, describing what can be run
91 * MD5 results for compressed and uncompressed files
92 * Special notes and caveats
93 * Release notes - go through git log for these.
94
95 ###File Copy
96
97 Place images in /ftp/iso-images on crater.dragonflybsd.org.  They will be rsynced to mirror-master.
98
99 ###announce
100 users@, web page