Merge pull request #15 from startersclan/chore/release-1.8.0

Chore: Release 1.8.0

README.md

@@ -37,21 +37,31 @@ a PHP frontend.
 `web` image (See [./web/config.php](./web/config.php) for supported environment variables):
 
 ```sh
-docker run --rm -it -e DB_ADDR=db -e DB_NAME=hlstatsxce -e DB_USER=hlstatsxce -e DB_PASS=hlstatsxce -p 80:80 startersclan/hlstatsx-community-edition:1.7.0-web
+docker run --rm -it -e DB_ADDR=db -e DB_NAME=hlstatsxce -e DB_USER=hlstatsxce -e DB_PASS=hlstatsxce -p 80:80 startersclan/hlstatsx-community-edition:1.8.0-web
 ```
 
 `daemon` image:
 
 ```sh
 # Use --help for usage
-docker run --rm -it -p 27500:27500/udp startersclan/hlstatsx-community-edition:1.7.0-daemon --db-host=db:3306 --db-name=hlstatsxce --db-username=hlstatsxce --db-password=hlstatsxce #--help
+docker run --rm -it -p 27500:27500/udp startersclan/hlstatsx-community-edition:1.8.0-daemon --db-host=db:3306 --db-name=hlstatsxce --db-username=hlstatsxce --db-password=hlstatsxce #--help
 ```
 
 The tag convention is `<version>-<service>` or `<version>-<sha>-<service>`. For instance, for release `v1.2.3` on sha `0abcdef`:
 
 - `web` image tags: `1-web`, `1.2-web`, `1.2.3-web`, `1-0abcdef-web`, `1.2-0abcdef-web`, `1.2.3-0abcdef-web`
 - `daemon` image tags: `1-daemon`, `1.2-daemon`, `1.2.3-daemon`, `1-0abcdef-daemon`, `1.2-0abcdef-daemon`, `1.2.3-0abcdef-daemon`
 
+### Upgrading (docker)
+
+1. To be safe, stop the `daemon`.
+1. Upgrade `web`:
+    1. Bump the docker image to the latest tag
+    1. Login to the `web` Admin Panel, there should be a notice to upgrade the DB. Click the `HLX:CE Database Updater` button to begin upgrading. The upgrade may take a while.
+    1. After a few moments, you should see messages that the DB was successfully upgraded
+1. Upgrade `daemon`:
+    1. Simply bump the docker image to the latest tag
+
 ## Development
 
 ```sh

release.sh

@@ -0,0 +1,51 @@
+#!/bin/sh
+# This script makes it easy to create a new release.
+# It requires git, which is only used to detect the previous tag.
+
+set -eu
+
+TAG=${1:-}
+COMMENT=${2:-}
+if [ -z "$TAG" ]; then
+    echo "Please specify a tag as a first argument. E.g. v1.2.3"
+    exit 1
+fi
+TAG_REGEX='^v?[0-9]+\.[0-9]+\.[0-9]+$'
+if ! echo "$TAG" | grep -E "$TAG_REGEX" > /dev/null; then
+    echo "Tag does not match regex: $TAG_REGEX"
+    exit 1
+fi
+TAG_PREV=$( git --no-pager tag -l --sort=-version:refname | head -n1 )
+if ! echo "$TAG_PREV" | grep -E "$TAG_REGEX" > /dev/null; then
+    echo "Previous git tag is invalid. It does not match regex: $TAG_REGEX"
+    exit 1
+fi
+
+VERSION=$( echo "$TAG" | sed 's/^v//' )
+VERSION_PREV=$( echo "$TAG_PREV" | sed 's/^v//' )
+DBVERSION_PREV=$( ls web/updater | grep -E '^[0-9]+\.php$' | sort -n | tail -n1 | cut -d '.' -f1 )
+DBVERSION=$(( $DBVERSION_PREV + 1 ))
+
+# Bump version in docs, .php, and .sql files
+sed -i "s/$VERSION_PREV/$VERSION/" README.md
+sed -i "s/^SET @DBVERSION=.*/SET @DBVERSION=\"$DBVERSION\";/" sql/install.sql
+sed -i "s/^SET @VERSION=.*/SET @VERSION=\"$VERSION\";/" sql/install.sql
+echo "Creating web/updater/$DBVERSION.php"
+cat - > web/updater/$DBVERSION.php <<EOF
+<?php
+    if ( !defined('IN_UPDATER') )
+    {
+        die('Do not access this file directly.');
+    }
+
+    \$dbversion = $DBVERSION;
+    \$version = "$VERSION";
+
+    // Perform database schema update notification
+    print "Updating database and verion schema numbers.<br />";
+    \$db->query("UPDATE hlstats_Options SET \`value\` = '\$version' WHERE \`keyname\` = 'version'");
+    \$db->query("UPDATE hlstats_Options SET \`value\` = '\$dbversion' WHERE \`keyname\` = 'dbversion'");
+?>
+EOF
+
+echo "Done bumping version to $TAG in all files"

sql/install.sql

@@ -2,8 +2,8 @@
 
 -- This file is only needed for new installations.
 
-SET @DBVERSION="80";
-SET @VERSION="1.7.0";
+SET @DBVERSION="81";
+SET @VERSION="1.8.0";
 
 -- --------------------------------------------------------
 

web/updater/79.php

@@ -0,0 +1,15 @@
+<?php
+    // Dummy upgrade file. Changes in ./sql/migrations/*.sql should have been added here
+    if ( !defined('IN_UPDATER') )
+    {
+        die('Do not access this file directly.');
+    }
+
+    $dbversion = 79;
+    $version = "1.7.0";
+
+    // Perform database schema update notification
+    print "Updating database and verion schema numbers.<br />";
+    $db->query("UPDATE hlstats_Options SET `value` = '$version' WHERE `keyname` = 'version'");
+    $db->query("UPDATE hlstats_Options SET `value` = '$dbversion' WHERE `keyname` = 'dbversion'");
+?>

web/updater/80.php

@@ -0,0 +1,15 @@
+<?php
+    // Dummy upgrade file. Changes in ./sql/migrations/*.sql should have been added here
+    if ( !defined('IN_UPDATER') )
+    {
+        die('Do not access this file directly.');
+    }
+
+    $dbversion = 80;
+    $version = "1.7.0";
+
+    // Perform database schema update notification
+    print "Updating database and verion schema numbers.<br />";
+    $db->query("UPDATE hlstats_Options SET `value` = '$version' WHERE `keyname` = 'version'");
+    $db->query("UPDATE hlstats_Options SET `value` = '$dbversion' WHERE `keyname` = 'dbversion'");
+?>

web/updater/81.php

@@ -0,0 +1,14 @@
+<?php
+    if ( !defined('IN_UPDATER') )
+    {
+        die('Do not access this file directly.');
+    }
+
+    $dbversion = 81;
+    $version = "1.8.0";
+
+    // Perform database schema update notification
+    print "Updating database and verion schema numbers.<br />";
+    $db->query("UPDATE hlstats_Options SET `value` = '$version' WHERE `keyname` = 'version'");
+    $db->query("UPDATE hlstats_Options SET `value` = '$dbversion' WHERE `keyname` = 'dbversion'");
+?>