Note about committing before tag.
[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
48On master:
ad252dc8 49
50 vi sys/sys/param.h
51
b73857e2 52Edit \__DragonFly\_version and related comments. Put in commented numbers for the new release and master.
ad252dc8 53
54 vi sys/conf/newvers.sh
55
56Edit BRANCH, use 'DEVELOPMENT', update version.
57
d3400016 58 vi gnu/usr.bin/groff/tmac/mdoc.local
59
60In 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
ad252dc8 62##Tagging
63
d6324ea2 64Make sure all changes on the master branch **and** on the new branch have been committed and pushed before tagging anything.
65
d3400016 66 git add sys/sys/param.h sys/conf/newvers.sh gnu/usr.bin/groff/tmac/mdoc.local
d6324ea2 67 git commit
68 git push
ad252dc8 69
70man 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
d6324ea2 74 git tag -s -m "DragonFly x.x.0" vx.x.0
ad252dc8 75 git push --tags
76
77###In the new branch
78
d6324ea2 79 git tag -s -m "DragonFly x.y.0" vx.y.0
ad252dc8 80 git push --tags
81
82Do 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
84e25cdb 84A new tag may require a commit beforehand to the release branch to make sure it goes to the right branch.
85
930c5043 86## Subsequent tag updates
87
56952daa 88When updating a x.x.1 version, you just need to tag.
47036946 89
bdb68a03 90## Something in GCC
91
92The 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
c0808637 96This comes from John Marino's commit:
97
98<http://gitweb.dragonflybsd.org/dragonfly.git/commitdiff/43add724990da155c21ef4a0893f4ebc2c36eb05>
99
ad252dc8 100##Pkgsrc
101
102Adjust bulk builds to the release's pkgsrc branch, and make sure they upload to the right directories on avalon.dragonflybsd.org.
103
104Adjust the default pkgsrc checkout in /usr/src/etc/Makefile.usr for both master and the new branch if necessary.
86b77dc1 105
86b77dc1 106###build isos and imgs
107
d513516b 108
109
86b77dc1 110###build pkgsrc packages
111
c3559da8 112###Testing
86b77dc1 113
c3559da8 114Testing should be done on real hardware, qemu and vmware. We have six isos/imgs that needs testing.
86b77dc1 115
c3559da8 116i386 iso, img, gui-img<br/>
117x86_64 iso, img, gui-img
86b77dc1 118
c3559da8 119Test this:
86b77dc1 120
c3559da8 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.
86b77dc1 125
d513516b 126###Release Notes
127
128Copy 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
94bdda57 137#### Minor releases
138
139* Update the release page, the main page, and the general [[Download]] page.
140* Add new MD5 sums.
141
d513516b 142###File Copy
86b77dc1 143
d513516b 144Place images in /ftp/iso-images on crater.dragonflybsd.org. They will be rsynced to mirror-master.
86b77dc1 145
146###announce
147users@, web page