From 73fb16f7ac376fc7c5ef53c02cc3ab9fdb3bcedb Mon Sep 17 00:00:00 2001
From: Aleksander Morgado <aleksander@aleksander.es>
Date: Fri, 22 Jan 2021 10:24:32 +0100
Subject: build: add new RELEASING doc explaining how releases are made

---
 RELEASING | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 RELEASING

(limited to 'RELEASING')

diff --git a/RELEASING b/RELEASING
new file mode 100644
index 00000000..7efec56a
--- /dev/null
+++ b/RELEASING
@@ -0,0 +1,35 @@
+
+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
+
+TODO: manpages and gtk-doc references
+
+-------------------------------------------------------------------------------
+
+*) 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
-- 
cgit v1.2.1