RELEASING

The libqmi releases are generated using the GNU autotools.

1) Configure and build the whole project, making sure gtk-doc is enabled:

    $ NOCONFIGURE=1 ./autogen.sh
    $ ./configure --enable-gtk-doc
    $ make -j8

2) Run distcheck so that the source distribution tarball is generated, and the
   project test suite is run on it:

    $ make distcheck

3) Compute checksum of the tarball so that it can be referenced in the release
   email:

    $ sha256sum libqmi-${VERSION}.tar.xz

4) Sign release tarball, and verify it (*):

    $ gpg --detach-sign --armor libqmi-${VERSION}.tar.xz
    $ gpg --verify libqmi-${VERSION}.tar.xz.asc libqmi-${VERSION}.tar.xz

5) Upload source tarball (.tar.xz) and signature (.tar.xz.asc) to
   freedesktop.org.
    $ scp libqmi-${VERSION}.tar.xz* fd.o:${libqmi}/

6) Create directories for the manpages and gtk-doc documentation in
   freedesktop.org, and also update the 'latest' links:
    $ ssh fd.o
    [fd.o] $ cd ${libqmi}/man/
    [fd.o] $ rm latest
    [fd.o] $ mkdir -p ${VERSION}
    [fd.o] $ ln -s ${VERSION} latest
    [fd.o] $ cd ${libqmi}/libqmi-glib/
    [fd.o] $ rm latest
    [fd.o] $ mkdir -p ${VERSION}
    [fd.o] $ ln -s ${VERSION} latest

7) Generate HTML for the manpages:
    $ roffit < docs/man/qmicli.1 > qmicli.1.html
    $ roffit < docs/man/qmi-network.1 > qmi-network.1.html
    $ roffit < docs/man/qmi-firmware-update.1 > qmi-firmware-update.1.html

8) Upload manpages in HTML to freedesktop.org:
    $ scp *.1.html fd.o:${libqmi}/man/${VERSION}/

9) Upload the gtk-doc in HTML available inside the source tarball to
   freedesktop.org. It must be the one inside the tarball because it contains
   the correct fixed refs to the online documentation of the dependencies
   (e.g. the glib/gobject/gio documentation URLs in http://developer.gnome.org)
    $ tar -Jxvf libqmi-${VERSION}.tar.xz
    $ scp libqmi-${VERSION}/docs/reference/libqmi-glib/html/* fd.o:${libqmi}/libqmi-glib/${VERSION}/

-------------------------------------------------------------------------------

*) Verifying the release signature requires the public key of the person who
   signed it, e.g.:

    $ curl https://www.freedesktop.org/software/libqmi/0x3CAD53398973FFFA.asc | gpg --import