summaryrefslogtreecommitdiff
path: root/RELEASING
diff options
context:
space:
mode:
authorAleksander Morgado <aleksandermj@chromium.org>2022-10-12 20:35:43 +0000
committerAleksander Morgado <aleksandermj@chromium.org>2022-10-12 20:42:40 +0000
commit63941aff85d482345798fc16d74c1551f79286d5 (patch)
treed44af675aefdc38c9da561768c8b0e47e1868bcb /RELEASING
parentbb1001dce7385004954c692dec101f716fe82ebb (diff)
downloadlibqmi-63941aff85d482345798fc16d74c1551f79286d5.tar.gz
RELEASING: switch to meson based steps
Diffstat (limited to 'RELEASING')
-rw-r--r--RELEASING67
1 files changed, 33 insertions, 34 deletions
diff --git a/RELEASING b/RELEASING
index 0ffe11a6..90bf8739 100644
--- a/RELEASING
+++ b/RELEASING
@@ -1,5 +1,5 @@
-The libqmi releases are generated using the GNU autotools.
+The libqmi releases are generated using meson.
0.1) For major releases:
* Increment qmi_minor_version and reset qmi_micro_version.
@@ -9,32 +9,26 @@ The libqmi releases are generated using the GNU autotools.
0.2) For stable branch releases:
* Increment qmi_micro_version.
-1) Configure and build the whole project, making sure gtk-doc is enabled:
+1) Add signed tag:
+ $ git tag -s 1.32.0
- $ NOCONFIGURE=1 ./autogen.sh
- $ ./configure --enable-gtk-doc
- $ make -j8
+ The description included in the signed tag could be:
+ Release 1.32.0
-2) Run distcheck so that the source distribution tarball is generated, and the
- project test suite is run on it:
+2) Configure and build the whole project, making sure gtk-doc and introspection
+ are enabled:
+ $ meson setup build \
+ --prefix=/usr \
+ --buildtype=release \
+ -Dintrospection=true \
+ -Dgtk_doc=true
+ $ ninja -C build
- $ make distcheck
+3) Run the test suite and install locally:
+ $ ninja -C build test
+ $ sudo ninja -C build install
-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
+4) 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/
@@ -46,20 +40,25 @@ The libqmi releases are generated using the GNU autotools.
[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
+5) Generate HTML for the manpages:
+ $ roffit < build/docs/man/qmicli.1 > qmicli.1.html
+ $ roffit < build/docs/man/qmi-network.1 > qmi-network.1.html
+ $ roffit < build/docs/man/qmi-firmware-update.1 > qmi-firmware-update.1.html
-8) Upload manpages in HTML to freedesktop.org:
+6) 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}/
+7) Copy documentation from /usr/share/gtk-doc and fix online references manually
+ $ mkdir html
+ $ cp -r /usr/share/gtk-doc/html/libqmi-glib/* html/
+ $ for FILE in $(ls html/*.html); do \
+ sed -i 's|<a[^>]* href="\.\./glib/[^"]*|<a href="https://docs.gtk.org/glib/|g' $FILE; \
+ sed -i 's|<a[^>]* href="\.\./gobject/[^"]*|<a href="https://docs.gtk.org/gobject/|g' $FILE; \
+ sed -i 's|<a[^>]* href="\.\./gio/[^"]*|<a href="https://docs.gtk.org/gio/|g' $FILE; \
+ done
+
+8) Upload the modified HTML files to freedesktop.org:
+ $ scp html/* fd.o:${libqmi}/libqmi-glib/${VERSION}/
10.1) For major releases:
* Fork new stable branch (e.g. qmi-${MAJOR}-${MINOR})