1
0
mirror of https://github.com/splitbrain/php-archive.git synced 2025-01-17 13:38:26 +01:00
php-archive/generate-api.sh

64 lines
1.7 KiB
Bash
Raw Normal View History

Add script and travis setup to automatically create docs Squashed commit of the following: commit aa7366d65b8b24542c08651d1f8b8bb3ce6f5001 Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 21:06:13 2015 +0200 removed apigen.phar, setup .gitignore commit 12a3da7477614ecc1d55318fe4551fbe1b92a0bc Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 21:03:45 2015 +0200 added some info within the generate-api script commit 47215ea47472db6e15a07795861c83962339cf77 Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:56:11 2015 +0200 added API docs to readme commit d67bda30107c0280c9f562e5e2156a0b0b6c2b6b Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:53:19 2015 +0200 abort when DST does not exist commit 2e769082a64040b1dc3583218ca96be6e8c481de Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:52:25 2015 +0200 Revert "try to set autocomplete values" This reverts commit 914d42546a1390250f858b08c172df4cc0d783df. commit 914d42546a1390250f858b08c172df4cc0d783df Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:50:21 2015 +0200 try to set autocomplete values commit e53cd155119ffb6be273f31233bd7ff3ad9f67cc Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:44:32 2015 +0200 added apigen config commit c32fa34db6cc67eeff4f6f0504759214876dfbdf Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:34:47 2015 +0200 fixed trigger branch commit 5bb8f757197cca9169a0264ce1e8f85aa4f6a74a Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:31:04 2015 +0200 another go commit 9e806b62360f315e24ae5586c1a9cbd94644acfa Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:26:53 2015 +0200 adjusted logic for travis compile commit 1b4e03ebd792d10ba67914404f357c1678d5a950 Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:22:45 2015 +0200 first go at automatic apidoc building
2015-08-05 21:07:59 +02:00
#!/bin/sh
# where's the source files?
SRC='src'
# for what branch to trigger
BRANCH='master'
# github repo
REPO='splitbrain/php-archive'
# ---- About -------------------------------------------------------
#
# This script use apigen to generate the documentation for the
# repository configured above. When run locally, the documentation
# will be placed in the 'docs' folder.
# However this script can also be run from travis. This requires
# the setup of a secret token as described at http://bit.ly/1MNbPn0
#
# Additional configuration can be done within an apigen.neon file
#
# ---- no modifications below ---------------------------------------
# when on travis, build outside of repository, otherwise locally
if [ -z "$TRAVIS" ]; then
DST='docs'
else
DST='../gh-pages'
2020-02-06 15:09:09 +01:00
if [ "$TRAVIS_PHP_VERSION" != '7.2' ]; then exit; fi
Add script and travis setup to automatically create docs Squashed commit of the following: commit aa7366d65b8b24542c08651d1f8b8bb3ce6f5001 Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 21:06:13 2015 +0200 removed apigen.phar, setup .gitignore commit 12a3da7477614ecc1d55318fe4551fbe1b92a0bc Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 21:03:45 2015 +0200 added some info within the generate-api script commit 47215ea47472db6e15a07795861c83962339cf77 Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:56:11 2015 +0200 added API docs to readme commit d67bda30107c0280c9f562e5e2156a0b0b6c2b6b Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:53:19 2015 +0200 abort when DST does not exist commit 2e769082a64040b1dc3583218ca96be6e8c481de Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:52:25 2015 +0200 Revert "try to set autocomplete values" This reverts commit 914d42546a1390250f858b08c172df4cc0d783df. commit 914d42546a1390250f858b08c172df4cc0d783df Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:50:21 2015 +0200 try to set autocomplete values commit e53cd155119ffb6be273f31233bd7ff3ad9f67cc Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:44:32 2015 +0200 added apigen config commit c32fa34db6cc67eeff4f6f0504759214876dfbdf Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:34:47 2015 +0200 fixed trigger branch commit 5bb8f757197cca9169a0264ce1e8f85aa4f6a74a Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:31:04 2015 +0200 another go commit 9e806b62360f315e24ae5586c1a9cbd94644acfa Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:26:53 2015 +0200 adjusted logic for travis compile commit 1b4e03ebd792d10ba67914404f357c1678d5a950 Author: Andreas Gohr <andi@splitbrain.org> Date: Wed Aug 5 20:22:45 2015 +0200 first go at automatic apidoc building
2015-08-05 21:07:59 +02:00
if [ "$TRAVIS_BRANCH" != "$BRANCH" ]; then exit; fi
if [ "$TRAVIS_PULL_REQUEST" != 'false' ]; then exit; fi
if [ -z "$GH_TOKEN" ]; then
echo "GH_TOKEN not set! See: http://bit.ly/1MNbPn0"
exit
fi
fi
# Get ApiGen.phar
wget http://www.apigen.org/apigen.phar -O apigen.phar
# Generate SDK Docs
php apigen.phar generate --template-theme="bootstrap" -s $SRC -d $DST
### if we're not on travis, we're done
if [ -z "$TRAVIS" ]; then exit; fi
# go to the generated docs
cd $DST || exit
# Set identity
git config --global user.email "travis@travis-ci.org"
git config --global user.name "Travis"
# Add branch
git init
git remote add origin https://${GH_TOKEN}@github.com/${REPO}.git > /dev/null
git checkout -B gh-pages
# Push generated files
git add .
git commit -m "Docs updated by Travis"
git push origin gh-pages -fq > /dev/null