Auto-generate phpDoc when committing to master
This commit is contained in:
Daniel Rudolf
parent
1f16be05e3
commit
c9387610f3
3 changed files with 99 additions and 16 deletions
26
.travis.yml
26
.travis.yml
|
|
@ -13,15 +13,31 @@ matrix:
|
|||
- php: nightly
|
||||
fast-finish: true
|
||||
|
||||
install:
|
||||
- composer install
|
||||
|
||||
before_script:
|
||||
- export PATH="$TRAVIS_BUILD_DIR/vendor/bin:$PATH"
|
||||
|
||||
script:
|
||||
- find . -not \( -path './vendor' -prune \) -type f -name '*.php' -print0 | xargs -0 -I file php -l file > /dev/null
|
||||
|
||||
after_success:
|
||||
- |
|
||||
[ "$DEPLOY_PHPDOC" == "yes" ] && (
|
||||
[ "$TRAVIS_BRANCH" == "master" ] && [ -z "$TRAVIS_TAG" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ] && (
|
||||
./build/generate-phpdoc.sh . "$TRAVIS_BUILD_DIR/build/phpdoc-master" "Pico 1.0 API Documentation (master@$TRAVIS_COMMIT)"
|
||||
./build/deploy-phpdoc.sh "$TRAVIS_BUILD_DIR/build/phpdoc-master" "$TRAVIS_REPO_SLUG" "gh-pages" "master@$TRAVIS_COMMIT"
|
||||
)
|
||||
)
|
||||
|
||||
before_deploy:
|
||||
- composer install
|
||||
- ./vendor/bin/phpdoc -d . -i 'vendor/*' -i 'plugins/*' -f 'plugins/DummyPlugin.php' -t "$TRAVIS_BUILD_DIR/build/phpdoc-$TRAVIS_TAG" --title "Pico 1.0 API Documentation ($TRAVIS_TAG)"
|
||||
- ./build/deploy-phpdoc.sh "picocms/Pico" "gh-pages" "$GITHUB_OAUTH_TOKEN" "$TRAVIS_BUILD_DIR/build/phpdoc-$TRAVIS_TAG" "phpDoc/$TRAVIS_TAG"
|
||||
- composer install --no-dev
|
||||
- composer dump-autoload --optimize
|
||||
- |
|
||||
[ "$DEPLOY_PHPDOC" == "yes" ] && (
|
||||
./build/generate-phpdoc.sh . "$TRAVIS_BUILD_DIR/build/phpdoc-$TRAVIS_TAG" "Pico 1.0 API Documentation ($TRAVIS_TAG)"
|
||||
./build/deploy-phpdoc.sh "$TRAVIS_BUILD_DIR/build/phpdoc-$TRAVIS_TAG" "$TRAVIS_REPO_SLUG" "gh-pages" "$TRAVIS_TAG"
|
||||
)
|
||||
- composer install --no-dev --optimize-autoloader
|
||||
- tar -czf "pico-release-$TRAVIS_TAG.tar.gz" README.md LICENSE CONTRIBUTING.md CHANGELOG.md composer.json composer.lock config content-sample lib plugins themes vendor .htaccess index.php
|
||||
|
||||
deploy:
|
||||
|
|
|
|||
|
|
@ -1,29 +1,82 @@
|
|||
#!/usr/bin/env bash
|
||||
APP_NAME="$(basename "$0")"
|
||||
BASE_PWD="$PWD"
|
||||
set -e
|
||||
|
||||
# environment variables
|
||||
# GITHUB_OAUTH_TOKEN GitHub authentication token, see https://github.com/settings/tokens
|
||||
|
||||
# parameters
|
||||
GITHUB_PROJECT="$1" # GitHub repo (e.g. picocms/Pico)
|
||||
GITHUB_BRANCH="$2" # branch to use (e.g. gh-pages)
|
||||
GITHUB_OAUTH_TOKEN="$3" # see https://github.com/settings/tokens
|
||||
SOURCE_DIR="$4" # absolute path to phpDocs target directory
|
||||
TARGET_DIR="$5" # relative path within the specified GitHub repo
|
||||
SOURCE_DIR="$1" # absolute local source path
|
||||
TARGET_REPO_SLUG="$2" # target repo (e.g. picocms/Pico)
|
||||
TARGET_BRANCH="$3" # target branch (e.g. gh-pages)
|
||||
TARGET_REF="$4" # target reference (either [branch]@[commit], [branch] or [tag])
|
||||
|
||||
# evaluate target reference
|
||||
if git check-ref-format "tags/$TARGET_REF"; then
|
||||
TARGET_REF_TYPE="tag"
|
||||
TARGET_REF_TAG="$TARGET_REF"
|
||||
TARGET_DIR="$TARGET_REF_TAG"
|
||||
elif [[ "$TARGET_REF" == *@* ]]; then
|
||||
TARGET_REF_TYPE="commit"
|
||||
TARGET_REF_BRANCH="${TARGET_REF%@*}"
|
||||
TARGET_REF_COMMIT="${TARGET_REF##*@}"
|
||||
TARGET_DIR="$TARGET_REF_BRANCH"
|
||||
|
||||
if ! git check-ref-format "heads/$TARGET_REF_BRANCH"; then
|
||||
echo "FATAL: $APP_NAME target reference '$TARGET_REF' is invalid" >&2
|
||||
exit 1
|
||||
fi
|
||||
elif git check-ref-format "heads/$TARGET_REF"; then
|
||||
TARGET_REF_TYPE="branch"
|
||||
TARGET_REF_BRANCH="$TARGET_REF"
|
||||
TARGET_DIR="$TARGET_REF_BRANCH"
|
||||
else
|
||||
echo "FATAL: $APP_NAME target reference '$TARGET_REF' is invalid" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# clone repo
|
||||
GIT_DIR="$(dirname "$0")/$(basename "$SOURCE_DIR").git"
|
||||
git clone -b "$GITHUB_BRANCH" "https://github.com/$GITHUB_PROJECT.git" "$GIT_DIR"
|
||||
GIT_DIR="$SOURCE_DIR.git"
|
||||
git clone -b "$TARGET_BRANCH" "https://github.com/$TARGET_REPO_SLUG.git" "$GIT_DIR"
|
||||
|
||||
# setup git
|
||||
cd "$GIT_DIR"
|
||||
git config user.name "Travis CI"
|
||||
git config user.email "travis-ci@picocms.org"
|
||||
[ -n "$GITHUB_OAUTH_TOKEN" ] && git config credential.https://github.com.username "$GITHUB_OAUTH_TOKEN"
|
||||
|
||||
# copy phpdoc
|
||||
[ -e "$TARGET_DIR" ] && echo "FATAL: $(basename "$0") target directory exists" && exit 1
|
||||
cp -R "$SOURCE_DIR" "$TARGET_DIR"
|
||||
[ -e "$TARGET_DIR" ] && echo "FATAL: $(basename "$0") target directory '$TARGET_DIR' exists" >&2 && exit 1
|
||||
[ "${SOURCE_DIR:0:1}" == "/" ] || SOURCE_DIR="$BASE_PWD/$SOURCE_DIR"
|
||||
cp -R "$SOURCE_DIR" "phpDoc/$TARGET_DIR"
|
||||
|
||||
# commit changes
|
||||
git add "$TARGET_DIR"
|
||||
git commit -m "Add phpDocumentor class docs for Pico $TRAVIS_TAG"
|
||||
git commit -m "Add phpDocumentor class docs for $TARGET_REF"
|
||||
|
||||
# very simple 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 [ "$TARGET_REF_TYPE" == "commit" ]; then
|
||||
# get latest commit
|
||||
LATEST_COMMIT="$(wget -O- "https://api.github.com/repos/$TARGET_REPO_SLUG/git/refs/heads/$TARGET_REF_BRANCH" 2> /dev/null | php -r "
|
||||
\$json = json_decode(stream_get_contents(STDIN), true);
|
||||
if (\$json !== null) {
|
||||
if (isset(\$json['ref']) && (\$json['ref'] === 'refs/heads/$TARGET_REF_BRANCH')) {
|
||||
if (isset(\$json['object']) && isset(\$json['object']['sha'])) {
|
||||
echo \$json['object']['sha'];
|
||||
}
|
||||
}
|
||||
}
|
||||
")"
|
||||
|
||||
# compare target reference against the latest commit
|
||||
if [ "$LATEST_COMMIT" != "$TARGET_REF_COMMIT" ]; then
|
||||
echo "WARNING: $APP_NAME target reference '$TARGET_REF' doesn't match the latest commit '$LATEST_COMMIT'" >&2
|
||||
exit 0
|
||||
fi
|
||||
fi
|
||||
|
||||
# push changes
|
||||
git push --force --quiet "https://${GITHUB_OAUTH_TOKEN}@github.com/$GITHUB_PROJECT.git" "$GITHUB_BRANCH:$GITHUB_BRANCH" > /dev/null 2>&1
|
||||
git push "https://github.com/$TARGET_REPO_SLUG.git" "$TARGET_BRANCH:$TARGET_BRANCH"
|
||||
|
|
|
|||
14
build/generate-phpdoc.sh
Normal file
14
build/generate-phpdoc.sh
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
#!/usr/bin/env bash
|
||||
set -e
|
||||
|
||||
# parameters
|
||||
PHPDOC_SOURCE_DIR="$1"
|
||||
PHPDOC_TARGET_DIR="$2"
|
||||
PHPDOC_TITLE="$3"
|
||||
|
||||
# generate phpdoc
|
||||
phpdoc -d "$PHPDOC_SOURCE_DIR" \
|
||||
-i 'build/*' -i 'vendor/*' -i 'plugins/*' \
|
||||
-f 'plugins/DummyPlugin.php' \
|
||||
-t "$PHPDOC_TARGET_DIR" \
|
||||
--title "$PHPDOC_TITLE"
|
||||
Loading…
Reference in a new issue