mis-pasted line in instructions

[ikiwiki.git] / docs / developer / Release / index.mdwn

#The art of releasing

This is a template on how to do a release.

##Branching

On crater branch the repo:

    cd /repository/git/dragonfly.git
    git branch DragonFly_RELEASE_x_y        (e.g. 2_8)

This is the only step that needs to happen remotely.

On your own system:

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.

    mkdir master
    cd master
    git init
    git remote add origin ssh://crater.dragonflybsd.org/repository/git/dragonfly.git
    git fetch origin

    cd ..
    cp -R master x_y 
    # x_y is the release; faster than rechecking out
    cd master
    git checkout master
    cd ..
    cd ../x_y/
    git branch DragonFly_RELEASE_x_y origin/DragonFly_RELEASE_x_y
    git checkout DragonFly_RELEASE_x_y 

On the new branch:

    vi sys/sys/param.h      

Edit \__DragonFly\_version and related comments.  You only need to add a commented version number for the branch, not the new master.

    vi sys/conf/newvers.sh  

Edit BRANCH, use 'RELEASE', update version.  e.g. RELEASE_2_8

    vi gnu/usr.bin/groff/tmac/mdoc.local

In the "Default .Os value" section, bump up the version to that of the release (even minor number).

Adjust 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.

On master:

    vi sys/sys/param.h

Edit \__DragonFly\_version and related comments.  Put in commented numbers for the new release and master.

    vi sys/conf/newvers.sh  

Edit BRANCH, use 'DEVELOPMENT', update version.

    vi gnu/usr.bin/groff/tmac/mdoc.local

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.

##Tagging

Make sure all changes on the master branch **and** on the new branch have been committed and pushed before tagging anything.

    git add sys/sys/param.h sys/conf/newvers.sh gnu/usr.bin/groff/tmac/mdoc.local
    git commit
    git push

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.

###In master

    git tag -s -m "DragonFly x.x.0" vx.x.0
    git push --tags

###In the new branch

    git tag -s -m "DragonFly x.y.0" vx.y.0
    git push --tags

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.

A new tag may require a commit beforehand to the release branch to make sure it goes to the right branch.

## Subsequent tag updates

When updating a x.x.1 version, you just need to tag.

## Something in GCC

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.

    #define        DFBSD_MAJOR     3

This comes from John Marino's commit:

<http://gitweb.dragonflybsd.org/dragonfly.git/commitdiff/43add724990da155c21ef4a0893f4ebc2c36eb05>

##Pkgsrc 

Adjust bulk builds to the release's pkgsrc branch, and make sure they upload to the right directories on avalon.dragonflybsd.org.

Adjust the default pkgsrc checkout in /usr/src/etc/Makefile.usr for both master and the new branch if necessary.

###build isos and imgs



###build pkgsrc packages

###Testing

Testing should be done on real hardware, qemu and vmware. We have six isos/imgs that needs testing.

i386 iso, img, gui-img<br/>
x86_64 iso, img, gui-img

Test this:

* Booting install media.
* Installing; encrypted, unencrypted, ufs, hammer.
* Configuring everything in the installer; try both dhcp and static IP.
* Booting the installed system.

###Release Notes

Copy one of the existing release pages.  The general format is :

* General announcement
* Big items new to this release
* Availability, describing what can be run
* MD5 results for compressed and uncompressed files
* Special notes and caveats
* Release notes - go through git log for these.

#### Minor releases

* Update the release page, the main page, and the general [[Download]] page.
* Add new MD5 sums on the release page for the compressed and uncompressed files.

###File Copy

Place images in /ftp/iso-images on crater.dragonflybsd.org.  They will be rsynced to mirror-master.

The 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.

###announce
users@, web page