aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2021-01-16 15:37:35 +0100
committerAleksander Morgado <aleksander@aleksander.es>2021-01-16 15:37:35 +0100
commitd1bc67936539b1cf59f07f8f168486263b0005f5 (patch)
tree6e51b13f3fa63c5ae06a427852e8a1944422ba77
parent9c353cf6f0a7650cfe1b914d6881890de9dff0b0 (diff)
build: add new RELEASING doc explaining how releases are made
-rw-r--r--RELEASING37
1 files changed, 37 insertions, 0 deletions
diff --git a/RELEASING b/RELEASING
new file mode 100644
index 00000000..8ae9a6e1
--- /dev/null
+++ b/RELEASING
@@ -0,0 +1,37 @@
+
+
+The ModemManager 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 ModemManager-${VERSION}.tar.xz
+
+4) Sign release tarball, and verify it (*):
+
+ $ gpg --detach-sign --armor ModemManager-${VERSION}.tar.xz
+ $ gpg --verify ModemManager-${VERSION}.tar.xz.asc ModemManager-${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/ModemManager/0x3CAD53398973FFFA.asc | gpg --import
+