Merge pull request #3614

initramfs (4):
      chore(build): deploy doxygen documentation on master branch pushes
      chore(build): parallelize travis and separate out doc build/deploy
      chore(build): add an error message on failure to deploy documentation
      chore(build): extract documentation build directory from doxygen config

.travis.yml

@@ -1,11 +1,20 @@
 sudo: required
 dist: trusty
 language: cpp
-os:
-- linux
-- osx
-script:
-- bash ./.travis/travis.sh
+
+matrix:
+  fast_finish: true
+  include:
+    - os: linux
+      env: JOB=verify-commit-format
+    - os: linux
+      env: JOB=build-docs DOXYGEN_CONFIG_FILE=doxygen.conf
+    - os: linux
+      env: JOB=build-ubuntu-14-04
+    - os: osx
+      env: JOB=build-osx
+
+script: "./.travis/$JOB.sh"
 
 deploy:
   provider: releases
@@ -17,3 +26,6 @@ deploy:
     repo: qTox/qTox
     tags: true
   skip_cleanup: true
+
+after_success:
+  - test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && test $JOB == "build-docs" && bash ./.travis/deploy-docs.sh

.travis/build-docs.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+#
+#    Copyright © 2016 by The qTox Project
+#
+#    This program is libre 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, see <http://www.gnu.org/licenses/>.
+#
+
+# Fail out on error
+set -eu -o pipefail
+
+# Obtain doxygen
+sudo apt-get install doxygen
+
+GIT_DESC=$(git describe --tags 2> /dev/null)
+GIT_CHASH=$(git rev-parse HEAD)
+
+# Append git version to doxygen version string
+echo "PROJECT_NUMBER = \"Version: $GIT_DESC | Commit: $GIT_CHASH\"" >> "$DOXYGEN_CONFIG_FILE"
+
+# Generate documentation
+echo "Generating documentation..."
+echo
+
+doxygen "$DOXYGEN_CONFIG_FILE"

.travis/build-osx.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+#
+#    Copyright © 2016 by The qTox Project
+#
+#    This program is libre 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, see <http://www.gnu.org/licenses/>.
+#
+
+# Fail out on error
+set -e -o pipefail
+
+# Build OSX
+bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -i
+bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -b
+bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -d
+# The following line can randomly fail due to travis emitting the error:
+# "hdiutil: create failed - Resource busy"
+bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -dmg

.travis/build-ubuntu-14-04.sh

@@ -14,6 +14,7 @@
 #
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 
 # stop as soon as one of steps will fail
 set -e -o pipefail

.travis/deploy-docs.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+#
+#    Copyright © 2016 by The qTox Project
+#
+#    This program is libre 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, see <http://www.gnu.org/licenses/>.
+#
+
+# Fail out on error
+set -eu -o pipefail
+
+# Extract html documentation directory from doxygen configuration
+OUTPUT_DIR_CFG=( $(grep 'OUTPUT_DIRECTORY' "$DOXYGEN_CONFIG_FILE") )
+HTML_OUTPUT_CFG=( $(grep 'HTML_OUTPUT' "$DOXYGEN_CONFIG_FILE") )
+
+DOCS_DIR="./${OUTPUT_DIR_CFG[2]}/${HTML_OUTPUT_CFG[2]}/"
+
+# Ensure docs exists
+if [ ! -d "$DOCS_DIR" ]
+then
+    echo "Docs deploy failing, no $DOCS_DIR present."
+    exit 1
+fi
+
+# Obtain git commit hash from HEAD
+GIT_CHASH=$(git rev-parse HEAD)
+
+# Push generated doxygen to GitHub pages
+cd "$DOCS_DIR"
+
+git --quiet init
+git config user.name "Travis CI"
+git config user.email "qTox@users.noreply.github.com"
+
+git add .
+git commit --quiet -m "Deploy to GH pages from commit: $GIT_CHASH"
+
+echo "Pushing to GH pages..."
+git push --force --quiet "https://${GH_TOKEN}@github.com/qTox/doxygen.git" master:gh-pages &> /dev/null

.travis/travis.sh

@@ -1,22 +0,0 @@
-#!/bin/bash
-#
-# Script that runs all the necessary tests on travis.
-#
-# Exits as soon as there's a failure in test.
-
-set -e
-
-if [[ "$TRAVIS_OS_NAME" == "linux" ]]
-then
-    # osx cannot into extended regexp for grep, thus verify only on Linux
-    bash ./verify-commit-messages.sh "$TRAVIS_COMMIT_RANGE"
-    bash ./.travis/build-ubuntu_14_04.sh
-elif [[ "$TRAVIS_OS_NAME" == "osx" ]]
-then
-    bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -i
-    bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -b
-    bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -d
-    # The following line can randomly fail due to travis emitting the error:
-    # "hdiutil: create failed - Resource busy"
-    bash ./osx/qTox-Mac-Deployer-ULTIMATE.sh -dmg
-fi

.travis/verify-commit-format.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+#
+#    Copyright © 2016 by The qTox Project
+#
+#    This program is libre 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, see <http://www.gnu.org/licenses/>.
+#
+
+# Fail out on error
+set -eu -o pipefail
+
+# Verify commit messages
+bash ./verify-commit-messages.sh "$TRAVIS_COMMIT_RANGE"