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