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