Skip to content

Commit

Permalink
Enable doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
eternauta1337 committed Feb 24, 2017
1 parent 67a3ca5 commit beef6b5
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 3 deletions.
8 changes: 6 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,20 @@
node_modules/
dist/
bundle/
docs/bin/

# Dev files
npm-debug.log


# Project property files
.actionScriptProperties
.flexLibProperties
.settings/
.idea/
.project
.DS_Store
*.iml
*.iml

# Misc
deploy_key
deploy_key.pub
7 changes: 7 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
language: node_js
node_js:
- stable
script: bash ./deploy.sh
env:
global:
- ENCRYPTION_LABEL: 8336be7f4b6c
74 changes: 74 additions & 0 deletions deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
#!/usr/bin/env bash

# See: https://gist.github.com/domenic/ec8b0fc8ab45f39403dd
# Script by Domenic

set -e # Exit with nonzero exit code if anything fails

SOURCE_BRANCH="dev"
TARGET_BRANCH="gh-pages"

function doCompile {
echo "Compiling docs..."
npm run docs
}

# Pull requests and commits to other branches shouldn't try to deploy, just build to verify
if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "$SOURCE_BRANCH" ]; then
echo "Not a dev branch commit, skipping docs deploy."
exit 0
fi

# 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`

# Clone the existing gh-pages for this repo into out/
# Create a new empty branch if gh-pages doesn't exist yet (should only happen on first deply)
echo "Creating deploy branch..."
git clone $REPO out
cd out
git checkout $TARGET_BRANCH || git checkout --orphan $TARGET_BRANCH
cd ..

# Clean out existing contents
echo "Clearing docs..."
mv out/.git .git-gh-pages || true
rm -rf out || exit 0
mkdir out
mv .git-gh-pages out/.git
ls -la out

# Run our compile script
echo "Compiling documentation..."
doCompile
rm -f docs/bin/docs.json
cp -r docs/bin/* out/
ls -la out

# Now let's go have some fun with the cloned repo
cd out
git config user.name "Travis CI"
git config user.email "palebluedot@gmail.com"

# Commit the "changes", i.e. the new version.
# The delta will show diffs between new and old versions.
echo "Committing changes..."
git add -A
git commit -m "Deploy to GitHub Pages: ${SHA}"

# Get the deploy key by using Travis's stored variables to decrypt key.enc
echo "Decrypting github keys..."
ENCRYPTED_KEY_VAR="encrypted_${ENCRYPTION_LABEL}_key"
ENCRYPTED_IV_VAR="encrypted_${ENCRYPTION_LABEL}_iv"
ENCRYPTED_KEY=${!ENCRYPTED_KEY_VAR}
ENCRYPTED_IV=${!ENCRYPTED_IV_VAR}
openssl aes-256-cbc -K $ENCRYPTED_KEY -iv $ENCRYPTED_IV -in ../deploy_key.enc -out deploy_key -d
chmod 600 deploy_key
eval `ssh-agent -s`
ssh-add deploy_key

# Now that we're all set up, we can push.
echo "Pushing build..."
git push $SSH_REPO $TARGET_BRANCH
Binary file added deploy_key.enc
Binary file not shown.
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"prebuild": "npm run clean:dist",
"build": "npm run tsc && npm run rollup && npm run uglifyjs",
"version": "npm run build",
"postversion": "git push && git push --tags && npm publish"
"postversion": "git push && git push --tags && npm publish",
"docs": "npm run rimraf -- docs/bin && node node_modules/@awayjs/typedoc-theme/awaydoc.js --name=materials"
},
"keywords": [
"AwayJS",
Expand All @@ -44,9 +45,11 @@
"tslib": "github:microsoft/tslib"
},
"devDependencies": {
"@awayjs/typedoc-theme": "^0.1.7",
"rimraf": "^2.5.2",
"rollup": "^0.36.4",
"rollup-plugin-includepaths": "^0.2.1",
"typedoc": "^0.5.7",
"typescript": "2.2.0-dev.20161123",
"uglifyjs": "^2.4.10"
}
Expand Down

0 comments on commit beef6b5

Please sign in to comment.