Debian Codegraph @

RELEASING

raw
1 The libqmi releases are generated using meson.
2
3
4 1) For major releases:
5 * Increment minor meson 'version' component (eg 1.x.y -> 1.x+1.0).
6 * Assuming API/ABI compatibility, increment both current and age.
7
8 2) For stable branch releases:
9 * Increment micro meson 'version' component (eg 1.x.y -> 1.x.y+1).
10
11 3) Configure and build the whole project, making sure gtk-doc and introspection
12 are enabled:
13 $ meson setup build \
14 --prefix=/usr \
15 --buildtype=release \
16 -Dintrospection=true \
17 -Dgtk_doc=true
18 $ ninja -C build
19
20 4) Run the test suite and install locally:
21 $ ninja -C build dist
22 $ sudo ninja -C build install
23
24 5) Push changes to a release MR on gitlab
25 * Use a commit title like "release: bump version to 1.38.0"
26 * Once CI passes merge the PR.
27
28 6) Add and push a signed tag:
29 $ git tag -s 1.38.0
30 (use a description like "Release 1.38.0")
31 $ git push tag 1.38.0
32
33 7) Create directories for the manpages and gtk-doc documentation in
34 freedesktop.org, and also update the 'latest' links:
35 $ ssh fd.o
36 [fd.o] $ cd ${libqmi}/man/
37 [fd.o] $ rm latest
38 [fd.o] $ mkdir -p ${VERSION}
39 [fd.o] $ ln -s ${VERSION} latest
40 [fd.o] $ cd ${libqmi}/libqmi-glib/
41 [fd.o] $ rm latest
42 [fd.o] $ mkdir -p ${VERSION}
43 [fd.o] $ ln -s ${VERSION} latest
44
45 8) Generate HTML for the manpages:
46 $ roffit < build/docs/man/qmicli.1 > qmicli.1.html
47 $ roffit < build/docs/man/qmi-network.1 > qmi-network.1.html
48 $ roffit < build/docs/man/qmi-firmware-update.1 > qmi-firmware-update.1.html
49
50 9) Upload manpages in HTML to freedesktop.org:
51 $ scp *.1.html fd.o:${libqmi}/man/${VERSION}/
52
53 10) Upload the HTML files to freedesktop.org:
54 $ scp build/docs/reference/libqmi-glib/libqmi-glib-1.0/* fd.o:${libqmi}/${VERSION}/
55
56 11) Copy documentation from /usr/share/gtk-doc and fix online references manually
57 $ mkdir html
58 $ cp -r /usr/share/gtk-doc/html/libqmi-glib/* html/
59 $ for FILE in $(ls html/*.html); do \
60 sed -i 's|<a[^>]* href="\.\./glib/[^"]*|<a href="https://docs.gtk.org/glib/|g' $FILE; \
61 sed -i 's|<a[^>]* href="\.\./gobject/[^"]*|<a href="https://docs.gtk.org/gobject/|g' $FILE; \
62 sed -i 's|<a[^>]* href="\.\./gio/[^"]*|<a href="https://docs.gtk.org/gio/|g' $FILE; \
63 done
64
65 12) Upload the modified HTML files to freedesktop.org:
66 $ scp html/* fd.o:${libqmi}/libqmi-glib/${VERSION}/
67
68 13) For major releases:
69 * Fork new stable branch (e.g. qmi-${MAJOR}-${MINOR})
70 * Post-release version bump in the master branch, increment minor meson 'version' component.
71 - Use a commit message like "build: unstable release version bump to 1.39.0"
72 * Post-release version bump in the stable branch, increment micro meson 'version' component.
73 - Use a commit message like "build: unstable release version bump to 1.38.1"
74
75 13.1) For stable branch releases:
76 * Post-release version bump, increment micro meson 'version' component.
77 - Use a commit message like "build: unstable release version bump to 1.38.1"
78
79 -------------------------------------------------------------------------------
80
81 *) Verifying the release signature requires the public key of the person who
82 signed it, e.g.:
83
84 $ curl https://www.freedesktop.org/software/libqmi/0xAECE0239C6606AD5.asc | gpg --import