site/

pages/

language: python

# Target Branch and Directory for Deployment of Docs

- PAGES_TARGET_BRANCH="gh-pages"

- PAGES_VERSION_BASE="version3"

- sudo pip install -r .travis/python_req.txt

- bash .travis/build_docs.sh

- bash .travis/push_docs_to_gh_pages.sh

mkdocs build --clean --strict

if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then

# ENV Variable checks are to help with configuration troubleshooting

# they silently exit with unique message. Anyone one of them not set

# can be used to turn off this functionality.

# For example a feature branch in the master repository that we don't want docs produced for yet.

[[ -n "$PAGES_VERSION_BASE" ]] || { echo "PAGES_VERSION_BASE Missing"; exit 0; }

[[ -n "$PAGES_TARGET_BRANCH" ]] || { echo "PAGES_TARGET_BRANCH Missing"; exit 0; }

[[ -n "$ENCRYPTION_LABEL" ]] || { echo "ENCRYPTION_LABEL Missing"; exit 0; }

# Fail because required script to generate documenation must have not been run, or was changed.

[[ -d ./site ]] || { echo "site directory not found"; exit 1; }

# Save some useful information

REPO=`git config remote.origin.url`

SSH_REPO=${REPO/https:\/\/github.com\//git@github.com:}

SHA=`git rev-parse --verify HEAD`

# shallow clone the repostoriy and switch to PAGES_TARGET_BRANCH branch

mkdir pages

cd pages

git clone --depth 1 $REPO .

PAGES_BRANCH_EXISTS=$(git ls-remote --heads $REPO $PAGES_TARGET_BRANCH)

if [ -n "$PAGES_BRANCH_EXISTS" ] ; then

echo "Pages Branch Found"

echo "-$PAGES_BRANCH_EXISTS-"

git remote set-branches origin $PAGES_TARGET_BRANCH

git fetch --depth 1 origin $PAGES_TARGET_BRANCH

git checkout $PAGES_TARGET_BRANCH

else

echo "Creating Pages Branch"

git checkout --orphan $PAGES_TARGET_BRANCH

git rm -rf .

fi

#clear out latest and copy site contents to it.

echo "updating $VERSION_BASE/latest"

mkdir -p $PAGES_VERSION_BASE/latest

rm -rf $PAGES_VERSION_BASE/latest/**./* || exit 0

cp -a ../site/. $PAGES_VERSION_BASE/latest

# If a Tagged Build then copy to it's own directory as well.

if [ -n "$TRAVIS_TAG" ]; then

echo "Creating $PAGES_VERSION_BASE/$TRAVIS_TAG"

mkdir -p $PAGES_VERSION_BASE/$TRAVIS_TAG || exit 0

cp -a ../site/. $PAGES_VERSION_BASE/$TRAVIS_TAG

fi

#Check if there are doc changes, if none exit the script

if [[ -z `git diff --exit-code` ]] && [ -n "$PAGES_BRANCH_EXISTS" ] ; then

echo "No changes to docs detected."

exit 0

fi

#Chganges where detected, so it's safe to write to log.

now=$(date +"%d %b %Y - %r")

export latest=" - [Latest Doc Change]($PAGES_VERSION_BASE/latest/) - Created $now"

if [ ! -f doc-history.md ]; then

echo "<!-- Auto generated in .travis/push_docs_to_gh_pages.sh -->" >doc-history.md

echo "#Doc Generation Log" >>doc-history.md

echo "" >>doc-history.md

echo "- 4th line placeholder see below" >>doc-history.md

echo "" >>doc-history.md

echo "##Released Version Doc History" >>doc-history.md

echo "" >>doc-history.md

fi

if [ -n "$TRAVIS_TAG" ]; then

echo " - [$TRAVIS_TAG]($PAGES_VERSION_BASE/$TRAVIS_TAG/) - Created $now" >>doc-history.md

fi

#replace 4th line in log

sed -i '4s@.*@'"$latest"'@' doc-history.md

#Setup Git with Commiter info

git config user.name "Travis CI"

git config user.email "utplsql@users.noreply.github.com"

#Add and Commit the changes back to pages repo.

git add .

git commit -m "Deploy to GitHub Pages: ${SHA}"

#unencrypt and configure deployment key

[[ -e ../.travis/deploy_key.enc ]] || { echo ".travis/deploy_key.enc file not found"; exit 1; }

ENCRYPTED_KEY_VAR="encrypted_${ENCRYPTION_LABEL}_key"

ENCRYPTED_IV_VAR="encrypted_${ENCRYPTION_LABEL}_iv"

ENCRYPTED_KEY=${!ENCRYPTED_KEY_VAR} > /dev/null 2> /dev/null

ENCRYPTED_IV=${!ENCRYPTED_IV_VAR} > /dev/null 2> /dev/null

openssl aes-256-cbc -K $ENCRYPTED_KEY -iv $ENCRYPTED_IV -in ../.travis/deploy_key.enc -out ../.travis/deploy_key -d > /dev/null 2> /dev/null

chmod 600 ../.travis/deploy_key

eval `ssh-agent -s`

ssh-add ../.travis/deploy_key

# Now that we're all set up, we can push.

echo "git push $SSH_REPO $PAGES_TARGET_BRANCH"

git push $SSH_REPO $PAGES_TARGET_BRANCH

mkdocs

#Version Information

**utPLSQL version 3** is licensed under [Apache 2.0]

(https://www.apache.org/licenses/LICENSE-2.0)

External code used in the development of this project, but is not required for use.

| Tool | License | Purpose |

| ---- | --------| --------|

| [Travis-Oracle](https://github.com/cbandy/travis-oracle) | [ISC](https://github.com/cbandy/travis-oracle/blob/master/LICENSE) | Install Oracle for Travis Builds |

| [mkDocs](http://www.mkdocs.org/) | [BSD](http://www.mkdocs.org/about/license/) | Produce HTML version of documentation |

**Note:** Version 1 & 2 of utPLSQL were licensed under GPL, version 3 was a complete rewrite from scratch which a allowed us to change the license to a more permissive license.

[](https://github.com/utPLSQL/utPLSQL)

[](https://www.apache.org/licenses/LICENSE-2.0)

[](http://utplsql-slack-invite.herokuapp.com/)

[](https://twitter.com/utPLSQL)

utPLSQL is hosted on [hosted on GitHub](https://github.com/utPLSQL/utPLSQL) and open source project.

Community help on this project is always appreciated, if your interested in helping please read our [guide to contributing](https://github.com/utPLSQL/utPLSQL/blob/master/CONTRIBUTING.md)

- Feel free post questions, bugs or issues]to the [issues area of GitHub](https://github.com/utPLSQL/utPLSQL/issues).

- Join developers the [utPLSQL team](http://utplsql-slack-invite.herokuapp.com) on [Slack](https://slack.com/)