2.x: Automatically publish the generated JavaDocs from CI (#5996)

* Experiment: auto publish JavaDocs

* Fix script error, add logging

* Have all package-list staged

* Fix another scripting error

* Fix copy paths

* Real pushback on snapshot builds.

* Pull requests should not trigger snapshot pushbacks

* Rename push.sh to push_javadoc.sh

Author: akarnokd

.travis.yml

@@ -20,6 +20,7 @@ script: gradle/buildViaTravis.sh
 # Code coverage
 after_success:
   - bash <(curl -s https://codecov.io/bash)
+  - bash gradle/push_javadoc.sh
 
 # cache between builds
 cache:

gradle/push_javadoc.sh

@@ -0,0 +1,120 @@
+#!/bin/bash
+# ----------------------------------------------------------
+# Automatically push back the generated JavaDocs to gh-pages
+# ----------------------------------------------------------
+# based on https://gist.github.com/willprice/e07efd73fb7f13f917ea
+
+# specify the common address for the repository
+targetRepo=github.com/ReactiveX/RxJava.git
+# =======================================================================
+
+# only for main pushes, for now
+if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
+	echo -e "Pull request detected, skipping JavaDocs pushback."
+	exit 0
+fi
+
+# get the current build tag if any
+buildTag="$TRAVIS_TAG"
+echo -e "Travis tag: '$buildTag'"
+
+if [ "$buildTag" == "" ]; then
+   buildTag="snapshot"
+else
+   buildTag="${buildTag:1}"
+fi
+
+echo -e "JavaDocs pushback for tag: $buildTag"
+
+# check if the token is actually there
+if [ "$GITHUB_TOKEN" == "" ]; then
+	echo -e "No access to GitHub, skipping JavaDocs pushback."
+	exit 0
+fi
+
+# prepare the git information
+git config --global user.email "[email protected]"
+git config --global user.name "Travis CI"
+
+# setup the remote
+echo -e "Adding the target repository to git"
+git remote add origin-pages https://${GITHUB_TOKEN}@${targetRepo} > /dev/null 2>&1
+
+# stash changes due to chmod
+echo -e "Stashing any local non-ignored changes"
+git stash
+
+# get the gh-pages
+echo -e "Update branches and checking out gh-pages"
+git fetch --all
+git branch -a
+git checkout -b gh-pages origin-pages/gh-pages
+
+# releases should update 2 extra locations
+if [ "$buildTag" != "snapshot" ]; then
+	# for releases, add a new directory with the new version
+	# and carefully replace the others
+	
+	# 1.) main javadoc
+	# ----------------
+	# remove the io subdir
+    echo -e "Removing javadoc/io" 
+	rm -r javadoc/io
+
+	# remove the html files
+    echo -e "Removing javadoc/*.html" 
+	rm javadoc/*.html
+
+	# copy the new doc
+    echo -e "Copying to javadoc/" 
+	yes | cp -rf ./build/docs/javadoc/ .
+	
+	# 2.) 2.x javadoc
+	# remove the io subdir
+    echo -e "Removing 2.x/javadoc/io" 
+	rm -r 2.x/javadoc/io
+
+	# remove the html files
+    echo -e "Removing 2.x/javadoc/*.html" 
+	rm 2.x/javadoc/*.html
+
+	# copy the new doc
+    echo -e "Copying to 2.x/javadoc/" 
+	yes | cp -rf ./build/docs/javadoc/ 2.x/
+fi
+
+# 3.) create a version/snapshot specific copy of the docs
+# clear the existing tag
+echo -e "Removing to 2.x/javadoc/${buildTag}" 
+rm -r 2.x/javadoc/${buildTag}
+
+# copy the new doc
+echo -e "Copying to 2.x/javadoc/${buildTag}" 
+yes | cp -rf ./build/docs/javadoc/ 2.x/javadoc/${buildTag}/
+
+
+# stage all changed and new files
+echo -e "Staging new files" 
+git add *.html
+git add *.css
+git add *.js
+git add *package-list*
+
+# remove tracked but deleted files
+echo -e "Removing deleted files"
+git add -u
+
+# commit all
+echo -e "commit Travis build: $TRAVIS_BUILD_NUMBER for $buildTag"
+git commit --message "Travis build: $TRAVIS_BUILD_NUMBER for $buildTag"
+
+# debug file list
+#find -name "*.html"
+
+# push it
+echo -e "Pushing back changes."
+git push --quiet --set-upstream origin-pages gh-pages
+
+
+# we are done
+echo -e "JavaDocs pushback complete."