release_management.txt 3.27 KB
Newer Older
1 2 3 4 5
===================================
Sofia-SIP release management README
===================================

:Author: Kai Vehmanen <kai -dot vehmanen -at- nokia -dot- com>
6
:Version: 20060210-5
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
:Formatting: reStructuredText, http://docutils.sourceforge.net/rst.html

Introduction
============

This README contains instructions for making 
new Sofia-SIP releases.

Links to other resources
========================

sofia-sip/README.developers

The release notes
=================

The release notes should contain the following
sections:

- about Sofia-SIP
    - copied verbatim from sofia-sip/README
- list of changes since last release
    - maintained in sofia-sip/RELEASE
30 31 32
    - see diff between cvs/darcs between previous and
      this version
    - written in freshmeat.net "Changes:" style 
33 34
- notes on API/ABI interface changes 
    - maintained in sofia-sip/RELEASE
35 36
    - all changes in public interfaces, plus other
      notes that developers should be aware of
37 38
- contributors to this release
    - maintained in sofia-sip/RELEASE
39 40 41
    - also sofia-sip/AUTHORS should be updated (file
      should list all persons/companies who have code/scripts/etc
      copyrighted to them in the sofia-sip tree)
42 43 44 45 46 47

Making the release tarball 
==========================

- update the version number in sofia-sip/configure.ac
- make sure everything that is supposed to be in the
48
  release is in CVS (use commands "cvs up" and "darcs w")
49
- run 'make distcheck' (requires automake-1.7 or newer)
50 51 52 53
- tag CVS tree and darcs repo with release tag
  'rel-sofia-sip-x_y_z', where x_y_z is the version number (see
  README.developers):

54 55
  cvs tag rel-sofia-sip-x_y_z
  darcs tag -m"rel-sofia-sip-x_y_z"
56

Pekka Pessi's avatar
Pekka Pessi committed
57 58 59
- calculate md5 and sha1 hashes using md5sum and sha1sum utils,
  and copy the values to the release-notes (see below)

60

61 62
Creating the release notes and updating the website
===================================================
63 64 65

- combine the sofia-sip/RELEASE contents with
  the template found from sfnet_www/templates/relnotes.txt
Pekka Pessi's avatar
Pekka Pessi committed
66
- store the resulting release notes to 
67
  sfnet_www/relnotes/relnotes-sofia-sip-x.y.z.txt
68
- add explicit link to the release notes to 
69
  sfnet_www/download.html (three most recent releases,
70
  see guidelines in the html comments)
71 72
- update sfnet_www/index.html to mention the latest
  release
73 74 75
- commit the change to CVS, and run the 
  sfnet_www/put_online.sh script at the sourceforge.net
  shell server
Pekka Pessi's avatar
Pekka Pessi committed
76

Pekka Pessi's avatar
Pekka Pessi committed
77 78 79 80 81 82 83 84 85 86
Uploading the release to sourceforge.net
========================================

- use the the 'Admin' -> 'File releases' tool for
  creating a new release
- to upload the file, you can use for example ncftpput:
  ncftpput -u anonymous -p USER@users.sourceforge.net upload.sourceforge.net /incoming/ sofia-sip-x.y.z.tar.gz
- attach the release notes (relnotes-sofia-sip-x.y.z.txt)
  to the file release

Pekka Pessi's avatar
Pekka Pessi committed
87 88 89 90 91 92 93
Announcing releases
===================

- send an announcement mail, containing the
  release notes, to sofia-sip-devel@isource.nokia.com
- post a news item to freshmeat.net 'sofia-sip'
  project (current project owner: Kai Vehmanen)
94 95 96 97 98 99 100 101 102 103

After release
=============

- replace the RELEASE file with RELEASE.template, and
  commit it to CVS/darcs.
- change version in configure.ac from "X.Y.Z" to 
  "X.Y.Zcvs" (as it is in many cases unknown what the 
  next version will be)
- make a "tree open for development" commit