Javadoc Tutorial

Currently we are not using the ghsites plugin to push javadoc sites to GH. This is done by:

• Checking out the tag of interest. Only build from tags!

git checkout gwt-maps-3.9.0-build-17

• Building it for release, skipping tests for speed

mvn clean install -Prelease -Dmaven.test.skip=true

• Let's hold onto that source jar

cp gwt-maps-api/target/gwt-maps-3.9.0-build-17-javadoc.jar ~/someTempDir/

• Now checkout the gh-pages branch where GH exposes files as web pages, reset to ensure no extra kruft

git checkout gh-pages
git reset --hard HEAD

• Make a new directory for the docs and explode the jar in there and commit

mkdir javadoc/3.9.0-build-17/
cd javadoc/3.9.0-build-17/
cp ~/someTempDir/gwt-maps-3.9.0-build-17-javadoc.jar .
unzip gwt-maps-3.9.0-build-17-javadoc.jar
rm gwt-maps-3.9.0-build-17-javadoc.jar
git commit -a -m "Added docs for 3.9.0-build-17"

• Let's make a branch for these changes and push them to GH for a pull request

git branch v3.9.0_build_17_updates 8cfdea095e03b408141c14d7166e1fdde5afcbe5
git push origin v3.9.0_build_17_updates

Note git log was used to fetch the hash for that commit to create the branch from. Also, the above could be compacted down with various config flags, but here is shown in long form for clarity.