SeaCMS/pico
3
0
Fork 0
Code Issues Pull Requests Activity

Refactor phpDoc deployment

Browse Source 
This should prevent empty phpDoc updates like 55b4a2b
This commit is contained in:
Daniel Rudolf 2015-11-30 14:53:10 +01:00
parent 771bdacf71
commit 76f243f925
5 changed files with 82 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -19,7 +19,6 @@ desktop.ini
/_build/phpdoc/ /_build/phpdoc/
/_build/phpdoc.cache/ /_build/phpdoc.cache/
/_build/phpdoc-*/ /_build/phpdoc-*/
/_build/phpdoc-*.git/
# User config # User config
/config/config.php /config/config.php

20
_build/deploy-phpdoc-branch.sh
View File

@ -16,15 +16,27 @@ if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
fi fi
PHPDOC_ID="${TRAVIS_BRANCH//\//_}" 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 \ generate-phpdoc.sh \
"$TRAVIS_BUILD_DIR/.phpdoc.xml" \ "$TRAVIS_BUILD_DIR/.phpdoc.xml" \
"$TRAVIS_BUILD_DIR/_build/phpdoc.cache" \ "$PHPDOC_CACHE_DIR" "$PHPDOC_TARGET_DIR" \
"$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \
"Pico 1.0 API Documentation ($TRAVIS_BRANCH branch)" "Pico 1.0 API Documentation ($TRAVIS_BRANCH branch)"
[ $? -eq 0 ] || exit 1 [ $? -eq 0 ] || exit 1
# deploy phpDocs
deploy-phpdoc.sh \ deploy-phpdoc.sh \
"$TRAVIS_REPO_SLUG" "heads/$TRAVIS_BRANCH @ $TRAVIS_COMMIT" "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \ "Update phpDocumentor class docs for $TRAVIS_BRANCH branch @ $TRAVIS_COMMIT" \
"$TRAVIS_REPO_SLUG" "gh-pages" "phpDoc/$PHPDOC_ID" "$TRAVIS_REPO_SLUG" "heads/$TRAVIS_BRANCH" "$TRAVIS_COMMIT"
[ $? -eq 0 ] || exit 1 [ $? -eq 0 ] || exit 1

20
_build/deploy-phpdoc-release.sh
View File

@ -3,15 +3,27 @@
[ "$DEPLOY_PHPDOC_RELEASES" == "true" ] || exit [ "$DEPLOY_PHPDOC_RELEASES" == "true" ] || exit
PHPDOC_ID="${TRAVIS_BRANCH//\//_}" 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 \ generate-phpdoc.sh \
"$TRAVIS_BUILD_DIR/.phpdoc.xml" \ "$TRAVIS_BUILD_DIR/.phpdoc.xml" \
"$TRAVIS_BUILD_DIR/_build/phpdoc.cache" \ "$PHPDOC_CACHE_DIR" "$PHPDOC_TARGET_DIR" \
"$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \
"Pico 1.0 API Documentation ($TRAVIS_TAG)" "Pico 1.0 API Documentation ($TRAVIS_TAG)"
[ $? -eq 0 ] || exit 1 [ $? -eq 0 ] || exit 1
# deploy phpDocs
deploy-phpdoc.sh \ deploy-phpdoc.sh \
"$TRAVIS_REPO_SLUG" "tags/$TRAVIS_TAG" "$TRAVIS_BUILD_DIR/_build/phpdoc-$PHPDOC_ID" \ "Update phpDocumentor class docs for $TRAVIS_TAG" \
"$TRAVIS_REPO_SLUG" "gh-pages" "phpDoc/$PHPDOC_ID" "$TRAVIS_REPO_SLUG" "tags/$TRAVIS_TAG" "$TRAVIS_COMMIT"
[ $? -eq 0 ] || exit 1 [ $? -eq 0 ] || exit 1

86
_build/deploy-phpdoc.sh
View File

@ -1,56 +1,32 @@
#!/usr/bin/env bash #!/usr/bin/env bash
set -e set -e
# base variables
APP_NAME="$(basename "$0")"
BASE_PWD="$PWD"
# environment variables # environment variables
# GITHUB_OAUTH_TOKEN GitHub authentication token, see https://github.com/settings/tokens # GITHUB_OAUTH_TOKEN GitHub authentication token, see https://github.com/settings/tokens
# parameters # parameters
SOURCE_REPO_SLUG="$1" # source GitHub repo (e.g. picocms/Pico) COMMIT_MESSAGE="$1" # commit message
SOURCE_REF="$2" # source reference (either "[ref] @ [commit]" or "[ref]", CHECK_REPO_SLUG="$2" # optional GitHub repo (e.g. picocms/Pico) to check
# [ref] can be e.g. heads/master or tags/v1.0.0) # its latest commit as basic race condition protection
SOURCE_DIR="$3" # absolute source path CHECK_REMOTE_REF="$3" # optional remote Git reference (e.g. heads/master)
TARGET_REPO_SLUG="$4" # target GitHub repo (e.g. picocms/Pico) CHECK_LOCAL_COMMIT="$4" # optional local commit SHA1
TARGET_BRANCH="$5" # target branch (e.g. gh-pages)
TARGET_DIR="$6" # relative target path
# print parameters # print parameters
echo "Deploying phpDocs..." echo "Deploying phpDocs..."
printf 'SOURCE_REPO_SLUG="%s"\n' "$SOURCE_REPO_SLUG" printf 'COMMIT_MESSAGE="%s"\n' "$COMMIT_MESSAGE"
printf 'SOURCE_REF="%s"\n' "$SOURCE_REF" printf 'CHECK_REPO_SLUG="%s"\n' "$CHECK_REPO_SLUG"
printf 'SOURCE_DIR="%s"\n' "$SOURCE_DIR" printf 'CHECK_REMOTE_REF="%s"\n' "$CHECK_REMOTE_REF"
printf 'TARGET_REPO_SLUG="%s"\n' "$TARGET_REPO_SLUG" printf 'CHECK_LOCAL_COMMIT="%s"\n' "$CHECK_LOCAL_COMMIT"
printf 'TARGET_BRANCH="%s"\n' "$TARGET_BRANCH"
printf 'TARGET_DIR="%s"\n' "$TARGET_DIR"
echo echo
# evaluate source reference # check for changes
if [[ "$SOURCE_REF" == *" @ "* ]]; then if [ -z "$(git status --porcelain)" ]; then
SOURCE_REF_TYPE="commit" echo "Nothing to deploy; skipping..."
SOURCE_REF_HEAD="${SOURCE_REF% @ *}" exit 0
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 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
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 # setup git
cd "$GIT_DIR" printf 'Preparing repo...\n'
git config user.name "Travis CI" git config user.name "Travis CI"
git config user.email "travis-ci@picocms.org" 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) (umask 077 && echo "https://GitHub:$GITHUB_OAUTH_TOKEN@github.com" > .git/credentials)
fi 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 # commit changes
printf '\nCommiting changes...\n' printf '\nCommiting changes...\n'
git add --all "$TARGET_DIR" git add --all
git commit --message="Update phpDocumentor class docs for $SOURCE_REF" 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`), # 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 # but it should give a basic protection without disabling concurrent builds completely
if [ "$SOURCE_REF_TYPE" == "commit" ]; then if [ -n "$CHECK_REPO_SLUG" ] && [ -n "$CHECK_REMOTE_REF" ] && [ -n "$CHECK_LOCAL_COMMIT" ]; then
# load branch data via GitHub APIv3 # retrieve information using GitHub APIv3
printf '\nRetrieving latest commit...\n' printf '\nChecking latest commit...\n'
LATEST_COMMIT_URL="https://api.github.com/repos/$SOURCE_REPO_SLUG/git/refs/$SOURCE_REF_HEAD" CHECK_API_URL="https://api.github.com/repos/$CHECK_REPO_SLUG/git/refs/$CHECK_REMOTE_REF"
if [ -n "$GITHUB_OAUTH_TOKEN" ]; then 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 else
LATEST_COMMIT_RESPONSE="$(wget -O- "$LATEST_COMMIT_URL" 2> /dev/null)" CHECK_API_RESPONSE="$(wget -O- "$CHECK_API_URL" 2> /dev/null)"
fi fi
# evaluate JSON response # 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); \$json = json_decode(stream_get_contents(STDIN), true);
if (\$json !== null) { 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'])) { if (isset(\$json['object']) && isset(\$json['object']['sha'])) {
echo \$json['object']['sha']; echo \$json['object']['sha'];
} }
@ -96,14 +66,14 @@ if [ "$SOURCE_REF_TYPE" == "commit" ]; then
")" ")"
# compare source reference against the latest commit # compare source reference against the latest commit
if [ "$LATEST_COMMIT" != "$SOURCE_REF_COMMIT" ]; then if [ "$CHECK_REMOTE_COMMIT" != "$CHECK_LOCAL_COMMIT" ]; then
echo "WARNING: $APP_NAME source reference '$SOURCE_REF' doesn't match the latest commit '$LATEST_COMMIT'" >&2 echo "WARNING: latest local commit '$CHECK_LOCAL_COMMIT' doesn't match latest remote commit '$CHECK_REMOTE_COMMIT'" >&2
exit 0 exit 0
fi fi
fi fi
# push changes # push changes
printf '\nPushing changes...\n' printf '\nPushing changes...\n'
git push "https://github.com/$TARGET_REPO_SLUG.git" "$TARGET_BRANCH:$TARGET_BRANCH" git push origin
echo echo

28
_build/generate-phpdoc.sh
View File

@ -2,10 +2,10 @@
set -e set -e
# parameters # parameters
PHPDOC_CONFIG="$1" PHPDOC_CONFIG="$1" # phpDoc config file
PHPDOC_CACHE_DIR="$2" PHPDOC_CACHE_DIR="$2" # phpDoc cache dir
PHPDOC_TARGET_DIR="$3" PHPDOC_TARGET_DIR="$3" # phpDoc output dir
PHPDOC_TITLE="$4" PHPDOC_TITLE="$4" # API docs title
# print parameters # print parameters
echo "Generating phpDocs..." echo "Generating phpDocs..."
@ -15,8 +15,24 @@ printf 'PHPDOC_TARGET_DIR="%s"\n' "$PHPDOC_TARGET_DIR"
printf 'PHPDOC_TITLE="%s"\n' "$PHPDOC_TITLE" printf 'PHPDOC_TITLE="%s"\n' "$PHPDOC_TITLE"
echo echo
# generate phpdoc # parse phpDoc files (i.e. update cache)
phpdoc --config "$PHPDOC_CONFIG" \ 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" \ --cache-folder "$PHPDOC_CACHE_DIR" \
--target "$PHPDOC_TARGET_DIR" \ --target "$PHPDOC_TARGET_DIR" \
--title "$PHPDOC_TITLE" --title "$PHPDOC_TITLE"