Updating ghpages for all projects

parent bc2f89f3
...@@ -19,6 +19,8 @@ function set_default_props() { ...@@ -19,6 +19,8 @@ function set_default_props() {
echo "Path to Maven is [${MAVEN_PATH}]" echo "Path to Maven is [${MAVEN_PATH}]"
REPO_NAME=${PWD##*/} REPO_NAME=${PWD##*/}
echo "Repo name is [${REPO_NAME}]" echo "Repo name is [${REPO_NAME}]"
SPRING_CLOUD_STATIC_REPO=${SPRING_CLOUD_STATIC_REPO:-git@github.com:spring-cloud/spring-cloud-static.git}
echo "Spring Cloud Static repo is [${SPRING_CLOUD_STATIC_REPO}"
} }
# Check if gh-pages exists and docs have been built # Check if gh-pages exists and docs have been built
...@@ -47,8 +49,7 @@ function retrieve_current_branch() { ...@@ -47,8 +49,7 @@ function retrieve_current_branch() {
CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD} CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD}
fi fi
echo "Current branch is [${CURRENT_BRANCH}]" echo "Current branch is [${CURRENT_BRANCH}]"
git checkout ${CURRENT_BRANCH} git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script"
} }
# Switches to the provided value of the release version. We always prefix it with `v` # Switches to the provided value of the release version. We always prefix it with `v`
...@@ -56,6 +57,13 @@ function switch_to_tag() { ...@@ -56,6 +57,13 @@ function switch_to_tag() {
git checkout v${VERSION} git checkout v${VERSION}
} }
# Build the docs if switch is on
function build_docs_if_applicable() {
if [[ "${BUILD}" == "yes" ]] ; then
./mvnw clean install -P docs -pl docs -DskipTests
fi
}
# Get the name of the `docs.main` property # Get the name of the `docs.main` property
# Get whitelisted branches - assumes that a `docs` module is available under `docs` profile # Get whitelisted branches - assumes that a `docs` module is available under `docs` profile
function retrieve_doc_properties() { function retrieve_doc_properties() {
...@@ -86,8 +94,19 @@ function stash_changes() { ...@@ -86,8 +94,19 @@ function stash_changes() {
# Switch to gh-pages branch to sync it with current branch # Switch to gh-pages branch to sync it with current branch
function add_docs_from_target() { function add_docs_from_target() {
local DESTINATION_REPO_FOLDER local DESTINATION_REPO_FOLDER
if [[ -z "${DESTINATION}" ]] ; then if [[ -z "${DESTINATION}" && -z "${CLONE}" ]] ; then
DESTINATION_REPO_FOLDER=${ROOT_FOLDER} DESTINATION_REPO_FOLDER=${ROOT_FOLDER}
elif [[ "${CLONE}" == "yes" ]]; then
mkdir -p ${ROOT_FOLDER}/target
local clonedStatic=${ROOT_FOLDER}/target/spring-cloud-static
if [[ ! -e "${clonedStatic}/.git" ]]; then
echo "Cloning Spring Cloud Static to target"
git clone ${SPRING_CLOUD_STATIC_REPO} ${clonedStatic}
else
echo "Spring Cloud Static already cloned - will pull changes"
cd ${clonedStatic} && git checkout gh-pages && git pull origin gh-pages
fi
DESTINATION_REPO_FOLDER=${clonedStatic}/${REPO_NAME}
else else
if [[ ! -e "${DESTINATION}/.git" ]]; then if [[ ! -e "${DESTINATION}/.git" ]]; then
echo "[${DESTINATION}] is not a git repository" echo "[${DESTINATION}] is not a git repository"
...@@ -178,7 +197,7 @@ function copy_docs_for_branch() { ...@@ -178,7 +197,7 @@ function copy_docs_for_branch() {
if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then
# Not ignored... # Not ignored...
# We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html
if [[ "${file}" == "${MAIN_ADOC_VALUE}.html" ]] ; then if [[ ("${file}" == "${MAIN_ADOC_VALUE}.html") || ("${file}" == "${REPO_NAME}.html") ]] ; then
# We don't want to copy the spring-cloud-sleuth.html # We don't want to copy the spring-cloud-sleuth.html
# we want it to be converted to index.html # we want it to be converted to index.html
cp -rf $f ${destination}/index.html cp -rf $f ${destination}/index.html
...@@ -207,15 +226,19 @@ function commit_changes_if_applicable() { ...@@ -207,15 +226,19 @@ function commit_changes_if_applicable() {
# Switch back to the previous branch and exit block # Switch back to the previous branch and exit block
function checkout_previous_branch() { function checkout_previous_branch() {
git checkout ${CURRENT_BRANCH} # If -version was provided we need to come back to root project
cd ${ROOT_FOLDER}
git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script"
if [ "$dirty" != "0" ]; then git stash pop; fi if [ "$dirty" != "0" ]; then git stash pop; fi
exit 0 exit 0
} }
# Assert if properties have been properly passed # Assert if properties have been properly passed
function assert_properties() { function assert_properties() {
if [[ "${VERSION}" != "" && -z "${DESTINATION}" ]] ; then echo "Version was set but destination was not!"; exit 1;fi echo "VERSION [${VERSION}], DESTINATION [${DESTINATION}], CLONE [${CLONE}]"
if [[ "${DESTINATION}" != "" && -z "${VERSION}" ]] ; then echo "Destination was set but version was not!"; exit 1;fi if [[ "${VERSION}" != "" && (-z "${DESTINATION}" && -z "${CLONE}") ]] ; then echo "Version was set but destination / clone was not!"; exit 1;fi
if [[ ("${DESTINATION}" != "" && "${CLONE}" != "") && -z "${VERSION}" ]] ; then echo "Destination / clone was set but version was not!"; exit 1;fi
if [[ "${DESTINATION}" != "" && "${CLONE}" == "yes" ]] ; then echo "Destination and clone was set. Pick one!"; exit 1;fi
} }
# Prints the usage # Prints the usage
...@@ -232,13 +255,19 @@ the script will work in the following manner: ...@@ -232,13 +255,19 @@ the script will work in the following manner:
with that version number will be created in the gh-pages branch. WARNING! No whitelist verification will take place with that version number will be created in the gh-pages branch. WARNING! No whitelist verification will take place
- if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will - if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will
switch to gh-pages of that repo and copy the generated docs to `docs/<project-name>/<version>` switch to gh-pages of that repo and copy the generated docs to `docs/<project-name>/<version>`
- if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will
switch to gh-pages of that repo and copy the generated docs to `docs/<project-name>/<version>`
USAGE: USAGE:
You can use the following options: You can use the following options:
-v|--version - the script will apply the whole procedure for a particular library version -v|--version - the script will apply the whole procedure for a particular library version
-d|--destination - the root of destination folder where the docs should be copied. E.g. point to spring-cloud-static folder -d|--destination - the root of destination folder where the docs should be copied. You have to use the full path.
E.g. point to spring-cloud-static folder. Can't be used with (-c)
-b|--build - will run the standard build process after checking out the branch
-c|--clone - will automatically clone the spring-cloud-static repo instead of providing the destination.
Obviously can't be used with (-d)
EOF EOF
} }
...@@ -266,6 +295,12 @@ case ${key} in ...@@ -266,6 +295,12 @@ case ${key} in
DESTINATION="$2" DESTINATION="$2"
shift # past argument shift # past argument
;; ;;
-b|--build)
BUILD="yes"
;;
-c|--clone)
CLONE="yes"
;;
-h|--help) -h|--help)
print_usage print_usage
exit 0 exit 0
...@@ -287,6 +322,7 @@ if [[ -z "${VERSION}" ]] ; then ...@@ -287,6 +322,7 @@ if [[ -z "${VERSION}" ]] ; then
else else
switch_to_tag switch_to_tag
fi fi
build_docs_if_applicable
retrieve_doc_properties retrieve_doc_properties
stash_changes stash_changes
add_docs_from_target add_docs_from_target
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment