summaryrefslogtreecommitdiff
path: root/RELEASING
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2022-02-15 15:34:04 +0100
committerAleksander Morgado <aleksander@aleksander.es>2022-02-15 15:34:30 +0100
commit54c82ad802fda6c118c6f747f14ddb659be99aa6 (patch)
tree0919d5a0c9272b729af8326b965cf08aaad35c1e /RELEASING
parented37ceacda9b0523c0759f5ddf3ca6b9e4f29e4f (diff)
downloadlibmbim-54c82ad802fda6c118c6f747f14ddb659be99aa6.tar.gz
RELEASING: update with meson specific steps
Diffstat (limited to 'RELEASING')
-rw-r--r--RELEASING65
1 files changed, 32 insertions, 33 deletions
diff --git a/RELEASING b/RELEASING
index 7949a70..3648d33 100644
--- a/RELEASING
+++ b/RELEASING
@@ -1,5 +1,5 @@
-The libmbim releases are generated using the GNU autotools.
+The libmbim releases are generated using meson.
0.1) For major releases:
* Increment mbim_minor_version and reset mbim_micro_version.
@@ -9,32 +9,26 @@ The libmbim releases are generated using the GNU autotools.
0.2) For stable branch releases:
* Increment mbim_micro_version.
-1) Configure and build the whole project, making sure gtk-doc is enabled:
+1) Add signed tag:
+ $ git tag -s 1.28.0
- $ NOCONFIGURE=1 ./autogen.sh
- $ ./configure --enable-gtk-doc
- $ make -j8
+ The description included in the signed tag could be:
+ Release 1.28.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 libmbim-${VERSION}.tar.xz
-
-4) Sign release tarball, and verify it (*):
-
- $ gpg --detach-sign --armor libmbim-${VERSION}.tar.xz
- $ gpg --verify libmbim-${VERSION}.tar.xz.asc libmbim-${VERSION}.tar.xz
-
-5) Upload source tarball (.tar.xz) and signature (.tar.xz.asc) to
- freedesktop.org.
- $ scp libmbim-${VERSION}.tar.xz* fd.o:${libmbim}/
-
-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 ${libmbim}/man/
@@ -46,26 +40,31 @@ The libmbim releases are generated using the GNU autotools.
[fd.o] $ mkdir -p ${VERSION}
[fd.o] $ ln -s ${VERSION} latest
-7) Generate HTML for the manpages:
+5) Generate HTML for the manpages:
$ roffit < docs/man/mbimcli.1 > mbimcli.1.html
$ roffit < docs/man/mbim-network.1 > mbim-network.1.html
-8) Upload manpages in HTML to freedesktop.org:
+6) Upload manpages in HTML to freedesktop.org:
$ scp *.1.html fd.o:${libmbim}/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 libmbim-${VERSION}.tar.xz
- $ scp libmbim-${VERSION}/docs/reference/libmbim-glib/html/* fd.o:${libmbim}/libmbim-glib/${VERSION}/
+7) Copy documentation from /usr/share/gtk-doc and fix online references manually
+ $ mkdir html
+ $ cp -r /usr/share/gtk-doc/html/libmbim-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:${libmbim}/libmbim-glib/${VERSION}/
-10.1) For major releases:
+9.1) For major releases:
* Fork new stable branch (e.g. mbim-${MAJOR}-${MINOR})
* Post-release version bump in the main branch, increment mbim_minor_version.
* Post-release version bump in the stable branch, increment mbim_micro_version.
-10.2) For stable branch releases:
+9.2) For stable branch releases:
* Post-release version bump, increment mbim_micro_version.
-------------------------------------------------------------------------------