From 47d2685c6d442e11beec6dbaad1278d2f0dc25e9 Mon Sep 17 00:00:00 2001
From: Daniel Rudolf <github.com@daniel-rudolf.de>
Date: Mon, 30 Nov 2015 16:54:45 +0100
Subject: [PATCH] phpDocs auto deployment: Disable cache for releases

---
 _build/deploy-phpdoc-branch.sh  |  4 +---
 _build/deploy-phpdoc-release.sh |  4 +---
 _build/generate-phpdoc.sh       | 29 ++++++++++++++++++-----------
 3 files changed, 20 insertions(+), 17 deletions(-)

diff --git a/_build/deploy-phpdoc-branch.sh b/_build/deploy-phpdoc-branch.sh
index ecbb132..fd4eaba 100755
--- a/_build/deploy-phpdoc-branch.sh
+++ b/_build/deploy-phpdoc-branch.sh
@@ -17,8 +17,6 @@ fi
 
 PHPDOC_ID="${TRAVIS_BRANCH//\//_}"
 PHPDOC_GIT_DIR="$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID.git"
-PHPDOC_CACHE_DIR="$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID.cache"
-PHPDOC_TARGET_DIR="$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID"
 
 # clone repo
 echo "Cloning repo..."
@@ -31,7 +29,7 @@ echo
 # generate phpDocs
 generate-phpdoc.sh \
     "$TRAVIS_BUILD_DIR/.phpdoc.xml" \
-    "$PHPDOC_CACHE_DIR" "$PHPDOC_TARGET_DIR" \
+    "$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID.cache" "$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID" \
     "Pico 1.0 API Documentation ($TRAVIS_BRANCH branch)"
 [ $? -eq 0 ] || exit 1
 
diff --git a/_build/deploy-phpdoc-release.sh b/_build/deploy-phpdoc-release.sh
index 0fee37d..e613808 100755
--- a/_build/deploy-phpdoc-release.sh
+++ b/_build/deploy-phpdoc-release.sh
@@ -4,8 +4,6 @@
 
 PHPDOC_ID="${TRAVIS_BRANCH//\//_}"
 PHPDOC_GIT_DIR="$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID.git"
-PHPDOC_CACHE_DIR="$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID.cache"
-PHPDOC_TARGET_DIR="$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID"
 
 # clone repo
 echo "Cloning repo..."
@@ -18,7 +16,7 @@ echo
 # generate phpDocs
 generate-phpdoc.sh \
     "$TRAVIS_BUILD_DIR/.phpdoc.xml" \
-    "$PHPDOC_CACHE_DIR" "$PHPDOC_TARGET_DIR" \
+    "-" "$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID" \
     "Pico 1.0 API Documentation ($TRAVIS_TAG)"
 [ $? -eq 0 ] || exit 1
 
diff --git a/_build/generate-phpdoc.sh b/_build/generate-phpdoc.sh
index 3f12fd5..d87a570 100755
--- a/_build/generate-phpdoc.sh
+++ b/_build/generate-phpdoc.sh
@@ -15,21 +15,28 @@ printf 'PHPDOC_TARGET_DIR="%s"\n' "$PHPDOC_TARGET_DIR"
 printf 'PHPDOC_TITLE="%s"\n' "$PHPDOC_TITLE"
 echo
 
-# parse phpDoc files (i.e. update cache)
-printf "\nUpdate phpDoc cache...\n"
-phpdoc project:parse --config "$PHPDOC_CONFIG" \
-    --target "$PHPDOC_CACHE_DIR"
+# update a separate phpDoc cache
+if [ "$PHPDOC_CACHE_DIR" != "-" ]; then
+    # parse phpDoc files (i.e. update cache)
+    printf "\nUpdate phpDoc cache...\n"
+    phpdoc project:parse --config "$PHPDOC_CONFIG" \
+        --target "$PHPDOC_CACHE_DIR"
 
-# check for changes
-printf '\nCheck for phpDoc cache changes...\n'
-if [ -z "$(git status --porcelain "$PHPDOC_CACHE_DIR")" ]; then
-    printf 'No changes detected; skipping phpDocs renewal...\n\n'
-    exit 0
+    # check for changes
+    printf '\nCheck for phpDoc cache changes...\n'
+    if [ -z "$(git status --porcelain "$PHPDOC_CACHE_DIR")" ]; then
+        printf 'No changes detected; skipping phpDocs renewal...\n\n'
+        exit 0
+    fi
+
+    # NOTE: actually the following command should be `phpdoc project:transform`
+    #       instead of `phpdoc project:run`, but the command seems to be broken...
+else
+    # create temporary cache files in PHPDOC_TARGET_DIR
+    PHPDOC_CACHE_DIR="$PHPDOC_TARGET_DIR"
 fi
 
 # transform phpDoc files (i.e. rewrite API docs)
-# NOTE: actually this should be `phpdoc project:transform`,
-#       but the command seems to be broken...
 printf '\nRewrite phpDocs...\n'
 rm -rf "$PHPDOC_TARGET_DIR"
 phpdoc project:run --config "$PHPDOC_CONFIG" \