aboutsummaryrefslogtreecommitdiffstats
path: root/tests/travis/gen_apidocs.sh
diff options
context:
space:
mode:
authorKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2016-10-22 22:43:25 +0200
committerKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2017-03-14 20:31:13 +0100
commit33153b8f3a2e4974ae5b1e9f4017f669e35207fe (patch)
treee4d67029439358c6decb25d04a79e1c65245a99f /tests/travis/gen_apidocs.sh
parentbdfdd23b36cac0881ef4096180e1c9242753dd49 (diff)
downloadvolse-hubzilla-33153b8f3a2e4974ae5b1e9f4017f669e35207fe.tar.gz
volse-hubzilla-33153b8f3a2e4974ae5b1e9f4017f669e35207fe.tar.bz2
volse-hubzilla-33153b8f3a2e4974ae5b1e9f4017f669e35207fe.zip
[FEATURE] :construction_worker: Extend Travis CI integration.
Testing several Travis CI features. Add DBs to travis execution matrix. Doxygen API docu generation and deployment to gh-pages. Update phpunit to 5.7.
Diffstat (limited to 'tests/travis/gen_apidocs.sh')
-rwxr-xr-xtests/travis/gen_apidocs.sh86
1 files changed, 86 insertions, 0 deletions
diff --git a/tests/travis/gen_apidocs.sh b/tests/travis/gen_apidocs.sh
new file mode 100755
index 000000000..dc25347c6
--- /dev/null
+++ b/tests/travis/gen_apidocs.sh
@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) 2016 Hubzilla
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+# Exit if anything fails
+set -e
+
+# Only create and deploy API documentation once, on first build job.
+# Waiting for upcoming 'Build Stages' Q1/Q2 2017 to make this cleaner.
+# https://github.com/travis-ci/travis-ci/issues/929
+if [[ "$TRAVIS_JOB_NUMBER" != "${TRAVIS_BUILD_NUMBER}.1" ]]; then
+ echo "Not the first build job. Creating API documentation only once is enough."
+ echo "We are finished ..."
+ exit
+fi
+
+# @TODO get newer doxygen
+echo "Doxygen version 1.7 is too old for us :("
+doxygen --version
+
+# Only build API documentation for master branch push
+if [[ "$TRAVIS_EVENT_TYPE" != "push" ]] || [[ "$TRAVIS_BRANCH" != "master" ]]; then
+ echo "Conditions not met to build API documentation."
+ echo "We are finished ..."
+ exit
+fi
+
+echo "Generating Doxygen API documentation for master ..."
+
+cd $TRAVIS_BUILD_DIR
+mkdir -p ./doc/html
+
+# Redirect stderr and stdout to log file and console
+doxygen $DOXYFILE 2>&1 | tee ./doc/html/doxygen.log
+
+# Check if GitHub token is configured in Travis to be able to push to the repo
+if [ -z "$GHP_TOKEN" ]; then
+ echo "No GitHub token configured in Travis, can not deploy to gh-pages ..."
+ echo "Add Environment Variable 'GHP_TOKEN' in Travis CI project settings"
+ echo "with a 'Personal access token' from GitHub with 'repo:public_repo'."
+ exit
+fi
+
+# Upload the API documentation to the gh-pages branch of the GitHub repository.
+# Only upload if Doxygen successfully created the documentation.
+if [ -d "doc/html" ] && [ -f "doc/html/index.html" ]; then
+ echo "Uploading API documentation to the gh-pages branch ..."
+
+ # Add the new API documentation as a Git commit
+ cd ./doc/html
+
+ # Create and configure a new git repo for committing to gh-pages
+ git init
+ # Add a fake Travis CI user
+ git config user.name "Travis CI"
+ git config user.email "travis@travis-ci.org"
+ # Add the generated API documentation
+ git add --all
+ git commit -q -m "API documentation generated by Travis build: ${TRAVIS_BUILD_NUMBER}" -m "From commit: ${TRAVIS_COMMIT}"
+
+ # No need for a history, force push to the remote gh-pages branch
+ git push -f "https://${GHP_TOKEN}@${GHP_REPO_REF}" master:gh-pages > /dev/null 2>&1
+else
+ echo "No API documentation files have been found" >&2
+ exit 1
+fi