From 76f243f92599e5ae56e6ba9f2a021dd8e99ea209 Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 30 Nov 2015 14:53:10 +0100 Subject: [PATCH 1/6] Refactor phpDoc deployment This should prevent empty phpDoc updates like 55b4a2b --- .gitignore | 1 - _build/deploy-phpdoc-branch.sh | 20 ++++++-- _build/deploy-phpdoc-release.sh | 20 ++++++-- _build/deploy-phpdoc.sh | 86 +++++++++++---------------------- _build/generate-phpdoc.sh | 28 ++++++++--- 5 files changed, 82 insertions(+), 73 deletions(-) diff --git a/.gitignore b/.gitignore index 7163361..9be633f 100644 --- a/.gitignore +++ b/.gitignore @@ -19,7 +19,6 @@ desktop.ini /_build/phpdoc/ /_build/phpdoc.cache/ /_build/phpdoc-*/ -/_build/phpdoc-*.git/ # User config /config/config.php diff --git a/_build/deploy-phpdoc-branch.sh b/_build/deploy-phpdoc-branch.sh index 71e073a..df0e3a0 100755 --- a/_build/deploy-phpdoc-branch.sh +++ b/_build/deploy-phpdoc-branch.sh @@ -16,15 +16,27 @@ if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then 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..." +git clone --branch="gh-pages" "https://github.com/$TRAVIS_REPO_SLUG.git" "$PHPDOC_GIT_DIR" +[ $? -eq 0 ] || exit 1 + +cd "$PHPDOC_GIT_DIR" +echo + +# generate phpDocs generate-phpdoc.sh \ "$TRAVIS_BUILD_DIR/.phpdoc.xml" \ - "$TRAVIS_BUILD_DIR/_build/phpdoc.cache" \ - "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \ + "$PHPDOC_CACHE_DIR" "$PHPDOC_TARGET_DIR" \ "Pico 1.0 API Documentation ($TRAVIS_BRANCH branch)" [ $? -eq 0 ] || exit 1 +# deploy phpDocs deploy-phpdoc.sh \ - "$TRAVIS_REPO_SLUG" "heads/$TRAVIS_BRANCH @ $TRAVIS_COMMIT" "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \ - "$TRAVIS_REPO_SLUG" "gh-pages" "phpDoc/$PHPDOC_ID" + "Update phpDocumentor class docs for $TRAVIS_BRANCH branch @ $TRAVIS_COMMIT" \ + "$TRAVIS_REPO_SLUG" "heads/$TRAVIS_BRANCH" "$TRAVIS_COMMIT" [ $? -eq 0 ] || exit 1 diff --git a/_build/deploy-phpdoc-release.sh b/_build/deploy-phpdoc-release.sh index 47b5795..9586dd2 100755 --- a/_build/deploy-phpdoc-release.sh +++ b/_build/deploy-phpdoc-release.sh @@ -3,15 +3,27 @@ [ "$DEPLOY_PHPDOC_RELEASES" == "true" ] || exit 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..." +git clone --branch="gh-pages" "https://github.com/$TRAVIS_REPO_SLUG.git" "$PHPDOC_GIT_DIR" +[ $? -eq 0 ] || exit 1 + +cd "$PHPDOC_GIT_DIR" +echo + +# generate phpDocs generate-phpdoc.sh \ "$TRAVIS_BUILD_DIR/.phpdoc.xml" \ - "$TRAVIS_BUILD_DIR/_build/phpdoc.cache" \ - "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \ + "$PHPDOC_CACHE_DIR" "$PHPDOC_TARGET_DIR" \ "Pico 1.0 API Documentation ($TRAVIS_TAG)" [ $? -eq 0 ] || exit 1 +# deploy phpDocs deploy-phpdoc.sh \ - "$TRAVIS_REPO_SLUG" "tags/$TRAVIS_TAG" "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \ - "$TRAVIS_REPO_SLUG" "gh-pages" "phpDoc/$PHPDOC_ID" + "Update phpDocumentor class docs for $TRAVIS_TAG" \ + "$TRAVIS_REPO_SLUG" "tags/$TRAVIS_TAG" "$TRAVIS_COMMIT" [ $? -eq 0 ] || exit 1 diff --git a/_build/deploy-phpdoc.sh b/_build/deploy-phpdoc.sh index 26d06b8..fec64c6 100755 --- a/_build/deploy-phpdoc.sh +++ b/_build/deploy-phpdoc.sh @@ -1,56 +1,32 @@ #!/usr/bin/env bash set -e -# base variables -APP_NAME="$(basename "$0")" -BASE_PWD="$PWD" - # environment variables # GITHUB_OAUTH_TOKEN GitHub authentication token, see https://github.com/settings/tokens # parameters -SOURCE_REPO_SLUG="$1" # source GitHub repo (e.g. picocms/Pico) -SOURCE_REF="$2" # source reference (either "[ref] @ [commit]" or "[ref]", - # [ref] can be e.g. heads/master or tags/v1.0.0) -SOURCE_DIR="$3" # absolute source path -TARGET_REPO_SLUG="$4" # target GitHub repo (e.g. picocms/Pico) -TARGET_BRANCH="$5" # target branch (e.g. gh-pages) -TARGET_DIR="$6" # relative target path +COMMIT_MESSAGE="$1" # commit message +CHECK_REPO_SLUG="$2" # optional GitHub repo (e.g. picocms/Pico) to check + # its latest commit as basic race condition protection +CHECK_REMOTE_REF="$3" # optional remote Git reference (e.g. heads/master) +CHECK_LOCAL_COMMIT="$4" # optional local commit SHA1 # print parameters echo "Deploying phpDocs..." -printf 'SOURCE_REPO_SLUG="%s"\n' "$SOURCE_REPO_SLUG" -printf 'SOURCE_REF="%s"\n' "$SOURCE_REF" -printf 'SOURCE_DIR="%s"\n' "$SOURCE_DIR" -printf 'TARGET_REPO_SLUG="%s"\n' "$TARGET_REPO_SLUG" -printf 'TARGET_BRANCH="%s"\n' "$TARGET_BRANCH" -printf 'TARGET_DIR="%s"\n' "$TARGET_DIR" +printf 'COMMIT_MESSAGE="%s"\n' "$COMMIT_MESSAGE" +printf 'CHECK_REPO_SLUG="%s"\n' "$CHECK_REPO_SLUG" +printf 'CHECK_REMOTE_REF="%s"\n' "$CHECK_REMOTE_REF" +printf 'CHECK_LOCAL_COMMIT="%s"\n' "$CHECK_LOCAL_COMMIT" echo -# evaluate source reference -if [[ "$SOURCE_REF" == *" @ "* ]]; then - SOURCE_REF_TYPE="commit" - SOURCE_REF_HEAD="${SOURCE_REF% @ *}" - SOURCE_REF_COMMIT="${SOURCE_REF##* @ }" - - if ! git check-ref-format "$SOURCE_REF_HEAD" || ! git rev-parse --verify "$SOURCE_REF_COMMIT" > /dev/null; then - echo "FATAL: $APP_NAME source reference '$SOURCE_REF' is invalid" >&2 - exit 1 - fi -elif git check-ref-format "$SOURCE_REF"; then - SOURCE_REF_TYPE="ref" -else - echo "FATAL: $APP_NAME source reference '$SOURCE_REF' is invalid" >&2 - exit 1 +# check for changes +if [ -z "$(git status --porcelain)" ]; then + echo "Nothing to deploy; skipping..." + exit 0 fi -# clone repo -printf 'Cloning repo...\n' -GIT_DIR="$SOURCE_DIR.git" -git clone --branch="$TARGET_BRANCH" "https://github.com/$TARGET_REPO_SLUG.git" "$GIT_DIR" - # setup git -cd "$GIT_DIR" +printf 'Preparing repo...\n' git config user.name "Travis CI" git config user.email "travis-ci@picocms.org" @@ -59,35 +35,29 @@ if [ -n "$GITHUB_OAUTH_TOKEN" ]; then (umask 077 && echo "https://GitHub:$GITHUB_OAUTH_TOKEN@github.com" > .git/credentials) fi -# copy phpdoc -printf '\nCopying phpDocs...\n' -[ ! -d "$TARGET_DIR" ] || rm -rf "$TARGET_DIR" -[ "${SOURCE_DIR:0:1}" == "/" ] || SOURCE_DIR="$BASE_PWD/$SOURCE_DIR" -cp -R "$SOURCE_DIR" "$TARGET_DIR" - # commit changes printf '\nCommiting changes...\n' -git add --all "$TARGET_DIR" -git commit --message="Update phpDocumentor class docs for $SOURCE_REF" +git add --all +git commit --message="$COMMIT_MESSAGE" -# very simple race condition protection for concurrent Travis builds +# race condition protection for concurrent Travis builds # this is no definite protection (race conditions are still possible during `git push`), # but it should give a basic protection without disabling concurrent builds completely -if [ "$SOURCE_REF_TYPE" == "commit" ]; then - # load branch data via GitHub APIv3 - printf '\nRetrieving latest commit...\n' - LATEST_COMMIT_URL="https://api.github.com/repos/$SOURCE_REPO_SLUG/git/refs/$SOURCE_REF_HEAD" +if [ -n "$CHECK_REPO_SLUG" ] && [ -n "$CHECK_REMOTE_REF" ] && [ -n "$CHECK_LOCAL_COMMIT" ]; then + # retrieve information using GitHub APIv3 + printf '\nChecking latest commit...\n' + CHECK_API_URL="https://api.github.com/repos/$CHECK_REPO_SLUG/git/refs/$CHECK_REMOTE_REF" if [ -n "$GITHUB_OAUTH_TOKEN" ]; then - LATEST_COMMIT_RESPONSE="$(wget -O- --header="Authorization: token $GITHUB_OAUTH_TOKEN" "$LATEST_COMMIT_URL" 2> /dev/null)" + CHECK_API_RESPONSE="$(wget -O- --header="Authorization: token $GITHUB_OAUTH_TOKEN" "$CHECK_API_URL" 2> /dev/null)" else - LATEST_COMMIT_RESPONSE="$(wget -O- "$LATEST_COMMIT_URL" 2> /dev/null)" + CHECK_API_RESPONSE="$(wget -O- "$CHECK_API_URL" 2> /dev/null)" fi # evaluate JSON response - LATEST_COMMIT="$(echo "$LATEST_COMMIT_RESPONSE" | php -r " + CHECK_REMOTE_COMMIT="$(echo "$CHECK_API_RESPONSE" | php -r " \$json = json_decode(stream_get_contents(STDIN), true); if (\$json !== null) { - if (isset(\$json['ref']) && (\$json['ref'] === 'refs/$SOURCE_REF_HEAD')) { + if (isset(\$json['ref']) && (\$json['ref'] === 'refs/$CHECK_REMOTE_REF')) { if (isset(\$json['object']) && isset(\$json['object']['sha'])) { echo \$json['object']['sha']; } @@ -96,14 +66,14 @@ if [ "$SOURCE_REF_TYPE" == "commit" ]; then ")" # compare source reference against the latest commit - if [ "$LATEST_COMMIT" != "$SOURCE_REF_COMMIT" ]; then - echo "WARNING: $APP_NAME source reference '$SOURCE_REF' doesn't match the latest commit '$LATEST_COMMIT'" >&2 + if [ "$CHECK_REMOTE_COMMIT" != "$CHECK_LOCAL_COMMIT" ]; then + echo "WARNING: latest local commit '$CHECK_LOCAL_COMMIT' doesn't match latest remote commit '$CHECK_REMOTE_COMMIT'" >&2 exit 0 fi fi # push changes printf '\nPushing changes...\n' -git push "https://github.com/$TARGET_REPO_SLUG.git" "$TARGET_BRANCH:$TARGET_BRANCH" +git push origin echo diff --git a/_build/generate-phpdoc.sh b/_build/generate-phpdoc.sh index 87536d5..82eee54 100755 --- a/_build/generate-phpdoc.sh +++ b/_build/generate-phpdoc.sh @@ -2,10 +2,10 @@ set -e # parameters -PHPDOC_CONFIG="$1" -PHPDOC_CACHE_DIR="$2" -PHPDOC_TARGET_DIR="$3" -PHPDOC_TITLE="$4" +PHPDOC_CONFIG="$1" # phpDoc config file +PHPDOC_CACHE_DIR="$2" # phpDoc cache dir +PHPDOC_TARGET_DIR="$3" # phpDoc output dir +PHPDOC_TITLE="$4" # API docs title # print parameters echo "Generating phpDocs..." @@ -15,8 +15,24 @@ printf 'PHPDOC_TARGET_DIR="%s"\n' "$PHPDOC_TARGET_DIR" printf 'PHPDOC_TITLE="%s"\n' "$PHPDOC_TITLE" echo -# generate phpdoc -phpdoc --config "$PHPDOC_CONFIG" \ +# 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 + echo "No changes detected, don't rewrite phpDoc API docs..." + exit 0 +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 phpDoc API docs...\n' +rm -rf "$PHPDOC_TARGET_DIR" +phpdoc project:run --config "$PHPDOC_CONFIG" \ --cache-folder "$PHPDOC_CACHE_DIR" \ --target "$PHPDOC_TARGET_DIR" \ --title "$PHPDOC_TITLE" From f5c721aba1ccfa3cfeaccdef0c91e862bfaa8a75 Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 30 Nov 2015 15:11:28 +0100 Subject: [PATCH 2/6] phpDocs auto deployment: Fix paths --- _build/deploy-phpdoc-branch.sh | 4 ++-- _build/deploy-phpdoc-release.sh | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_build/deploy-phpdoc-branch.sh b/_build/deploy-phpdoc-branch.sh index df0e3a0..ecbb132 100755 --- a/_build/deploy-phpdoc-branch.sh +++ b/_build/deploy-phpdoc-branch.sh @@ -17,8 +17,8 @@ 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" +PHPDOC_CACHE_DIR="$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID.cache" +PHPDOC_TARGET_DIR="$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID" # clone repo echo "Cloning repo..." diff --git a/_build/deploy-phpdoc-release.sh b/_build/deploy-phpdoc-release.sh index 9586dd2..0fee37d 100755 --- a/_build/deploy-phpdoc-release.sh +++ b/_build/deploy-phpdoc-release.sh @@ -5,7 +5,7 @@ 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" +PHPDOC_TARGET_DIR="$PHPDOC_GIT_DIR/phpDoc/$PHPDOC_ID" # clone repo echo "Cloning repo..." From fe10bca56b9363f0e63488d1f2b73737e6f20311 Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 30 Nov 2015 15:24:00 +0100 Subject: [PATCH 3/6] phpDocs auto deployment: Fix output formatting --- _build/deploy-phpdoc.sh | 2 +- _build/generate-phpdoc.sh | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_build/deploy-phpdoc.sh b/_build/deploy-phpdoc.sh index fec64c6..f916b9e 100755 --- a/_build/deploy-phpdoc.sh +++ b/_build/deploy-phpdoc.sh @@ -21,7 +21,7 @@ echo # check for changes if [ -z "$(git status --porcelain)" ]; then - echo "Nothing to deploy; skipping..." + printf 'Nothing to deploy; skipping...\n\n' exit 0 fi diff --git a/_build/generate-phpdoc.sh b/_build/generate-phpdoc.sh index 82eee54..3f12fd5 100755 --- a/_build/generate-phpdoc.sh +++ b/_build/generate-phpdoc.sh @@ -23,14 +23,14 @@ phpdoc project:parse --config "$PHPDOC_CONFIG" \ # check for changes printf '\nCheck for phpDoc cache changes...\n' if [ -z "$(git status --porcelain "$PHPDOC_CACHE_DIR")" ]; then - echo "No changes detected, don't rewrite phpDoc API docs..." + printf 'No changes detected; skipping phpDocs renewal...\n\n' exit 0 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 phpDoc API docs...\n' +printf '\nRewrite phpDocs...\n' rm -rf "$PHPDOC_TARGET_DIR" phpdoc project:run --config "$PHPDOC_CONFIG" \ --cache-folder "$PHPDOC_CACHE_DIR" \ From c88a26beffe7795e6dd8d0457aa1044728d8fb28 Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 30 Nov 2015 15:26:09 +0100 Subject: [PATCH 4/6] phpDocs auto deployment: Set default push strategy to simple --- _build/deploy-phpdoc.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/_build/deploy-phpdoc.sh b/_build/deploy-phpdoc.sh index f916b9e..2e6816e 100755 --- a/_build/deploy-phpdoc.sh +++ b/_build/deploy-phpdoc.sh @@ -27,6 +27,7 @@ fi # setup git printf 'Preparing repo...\n' +git config push.default simple git config user.name "Travis CI" git config user.email "travis-ci@picocms.org" From 47d2685c6d442e11beec6dbaad1278d2f0dc25e9 Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 30 Nov 2015 16:54:45 +0100 Subject: [PATCH 5/6] 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" \ From 67bbae184b893bb8252475be56e989fa7611ddcf Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 30 Nov 2015 17:23:25 +0100 Subject: [PATCH 6/6] phpDocs auto deployment: Fix output formatting --- _build/generate-phpdoc.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_build/generate-phpdoc.sh b/_build/generate-phpdoc.sh index d87a570..2408ac2 100755 --- a/_build/generate-phpdoc.sh +++ b/_build/generate-phpdoc.sh @@ -31,13 +31,14 @@ if [ "$PHPDOC_CACHE_DIR" != "-" ]; then # NOTE: actually the following command should be `phpdoc project:transform` # instead of `phpdoc project:run`, but the command seems to be broken... + echo else # create temporary cache files in PHPDOC_TARGET_DIR PHPDOC_CACHE_DIR="$PHPDOC_TARGET_DIR" fi # transform phpDoc files (i.e. rewrite API docs) -printf '\nRewrite phpDocs...\n' +printf 'Rewrite phpDocs...\n' rm -rf "$PHPDOC_TARGET_DIR" phpdoc project:run --config "$PHPDOC_CONFIG" \ --cache-folder "$PHPDOC_CACHE_DIR" \