Skip to content

Commit

Permalink
build: Check for NEWS and appdata updates for new releases
Browse files Browse the repository at this point in the history
At least 4 different bugs were filed against the Flathub version of
evince because Flatpak prominently shows the appdata version in the UI,
making users think that there was a bug in the packaging, or that the
package had not been updated.

Avoid this problem in the future by failing the build if the NEWS or
appdata files aren't updated on release.
  • Loading branch information
hadess committed Jun 16, 2023
1 parent 773e41e commit 3af0b56
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 0 deletions.
82 changes: 82 additions & 0 deletions check-news.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
#!/bin/sh

# Copyright (C) 2019 Red Hat, Inc.
# Author: Bastien Nocera <[email protected]>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


# Add to your top-level meson.build to check for an updated NEWS file
# when doing a "dist" release, similarly to automake's check-news:
# https://www.gnu.org/software/automake/manual/html_node/List-of-Automake-options.html
#
# Checks NEWS for the version number:
# meson.add_dist_script(
# find_program('check-news.sh').path(),
# '@0@'.format(meson.project_version())
# )
#
# Checks NEWS and data/foo.appdata.xml for the version number:
# meson.add_dist_script(
# find_program('check-news.sh').path(),
# '@0@'.format(meson.project_version()),
# 'NEWS',
# 'data/foo.appdata.xml'
# )

usage()
{
echo "$0 VERSION [FILES...]"
exit 1
}

check_version()
{
VERSION=$1
# Look in the first 15 lines for NEWS files, but look
# everywhere for other types of files
if [ "$2" = "NEWS" ]; then
DATA=`sed 15q $SRC_ROOT/"$2"`
else
DATA=`cat $SRC_ROOT/"$2"`
fi
case "$DATA" in
*"$VERSION"*)
:
;;
*)
echo "$2 not updated; not releasing" 1>&2;
exit 1
;;
esac
}

SRC_ROOT=${MESON_DIST_ROOT:-"./"}

if [ $# -lt 1 ] ; then usage ; fi

VERSION=$1
shift

if [ $# -eq 0 ] ; then
check_version $VERSION 'NEWS'
exit 0
fi

for i in $@ ; do
check_version $VERSION "$i"
done

exit 0
17 changes: 17 additions & 0 deletions meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,23 @@ gnome.post_install(
update_desktop_database: true,
)

is_stable = (ev_minor_version != 'alpha' and
ev_minor_version != 'beta' and
ev_minor_version != 'rc')
if is_stable
meson.add_dist_script(
find_program('check-news.sh').full_path(),
'@0@'.format(meson.project_version()),
'NEWS',
'org.gnome.Evince.appdata.xml.in'
)
else
meson.add_dist_script(
find_program('check-news.sh').full_path(),
'@0@'.format(meson.project_version()),
'NEWS',
)
endif

summary({'Platform...................': ev_platform,
'Debug mode.................': ev_debug,
Expand Down

0 comments on commit 3af0b56

Please sign in to comment.