# Release management of SigScheme

## 1. Acknowledgement

A part of this document is based on Release Manual for uim (draft) contributed to uim project by Jeroen Ruigrok van der Werven. Thank you for cooperation.

## 2. Versioning scheme

A SigScheme version number is built up as follows:

      major.minor.patchlevel

The minor number is incremented for every stable release. As an example: 1.2.3 will become 1.3.0 upon a new release.

There’s no limit to the minor version’s number, it will continue past 9 with 10, in other words: after release 1.9.2 we will see release 1.10.0.

The patchlevel number will only be increased in the case of a bug fix or a security fix.

There is no separate versioning for unstable versions, this is simply the source control’s trunk revision with development snapshots being called `sigscheme-snapshot-YYYYMMDD`. With `YYYYMMDD` standing for the year in four, the month in two, and the day in two digits when the snapshot was taken.

And no alpha, beta or RC versions are released for now since the source codes are still drastically changing and no profit can be obtained from a feature freeze.

## 3. Release procedures

### 3.1. Documents update

Update `RELNOTE` and `NEWS`.

### 3.2. Declaration

Let all SigScheme developers know that a release is emerging, and make sure that no developer is having a problem on the release.

### 3.3. Versioning

Confirm the version number written in `AC_INIT()` of the `configure.in` and SSCM_VERSION_* of sigscheme.h prior to a release.

And do not forget updating `src/libtool-version.mk` if `libsscm` ABI has been altered from previous version.

Finally, update LIBGCROOTS_URL in `make-dist.sh`.

### 3.4. Test

Make all tests passed.

    $ ./configure --enable-maintainer-mode --enable-conf=full
    $ make check

### 3.5. Tagging

A release must be branched and tagged for development management.

    $ git branch sigscheme-x.y <start-point>
    $ git push origin sigscheme-x.y

    $ git tag -a sigscheme-x.y.z <commit on sigscheme-x.y>
    $ git push --tags

If the release is a snapshot, tag as follows:

    $ git tag -a sigscheme-snapshot-YYYYMMDD
    $ git push --tags

### 3.6. Packaging

    $ cd /tmp
    $ git clone https://code.google.com/p/uim.sigscheme/
    $ git checkout sigscheme-x.y.z
    $ ./make-dist.sh

It produces:

    sigscheme-x.y.z.tar.gz
    sigscheme-x.y.z.tar.bz2
    sigscheme-x.y.z.sum

### 3.7. Publishing and announcements

Upload the file by the official uploading script:

    http://code.google.com/p/support/wiki/ScriptedUploads

Don’t forget adding appropriate tags as follows.

Final release:

      googlecode-upload.py -u yamakenz -p sigscheme \
                           -s 'SigScheme 0.8.0' -l 'Stable,Featured' \
                           sigscheme-0.8.0.tar.bz2

Alpha or beta release:

      googlecode-upload.py -u yamakenz -p sigscheme \
                           -s 'SigScheme 0.8.0-alpha' -l 'Unstable' \
                           sigscheme-0.8.0-alpha.tar.bz2

Snapshot release:

      googlecode-upload.py -u yamakenz -p sigscheme \
                           -s 'SigScheme trunk-snapshot20070703' -l 'Snapshot' \
                           sigscheme-trunk-snapshot20070703.tar.bz2

And untag Featured from previous final release files by the web interface.

Then update the web pages.

    http://code.google.com/p/sigscheme/
    http://code.google.com/p/sigscheme/wiki/SigScheme
    http://code.google.com/p/sigscheme/wiki/Download

Update SigScheme page first and copy it into the project description (homepage).

<obsolete> The checksums of the files must not directly be written into the anyone-rewritable wikipage, to prevent spoofings. It should be a link to the release announce which contain the checksum information. </obsolete>

And send a message to {sigscheme-ja,uim-en,uim-ja}@googlegroups.com

       <write announcement here>

         http://code.google.com/p/sigscheme/wiki/Download

       MD5 (sigscheme-0.8.0-example.tar.gz) = cff14a6ad95a6a1303b527a86d27bff4
       MD5 (sigscheme-0.8.0-example.tar.bz2) = b2e96af101a0c51df697990f6311f6f2
       SHA1 (sigscheme-0.8.0-example.tar.gz) = 3f152c4aa77a3a44d9f74800a8b9d8d3b6c16771
       SHA1 (sigscheme-0.8.0-example.tar.bz2) = c870c3e8585ce8e4200fe3247021802d922781c6

       <append RELNOTE here>

Update Freshmeat entry at last.

    http://freshmeat.net/projects/sigscheme/