diff --git a/spring-cloud-build.html b/spring-cloud-build.html index 0857ce1c..2234c881 100644 --- a/spring-cloud-build.html +++ b/spring-cloud-build.html @@ -100,6 +100,7 @@ $(addBlockSwitches);
  • Reusing the documentation
    • +
  • Updating the guides
    • @@ -540,6 +541,54 @@ The order of plugin declaration is important! +
    +

    Updating the guides

    +
    +
    +

    We assume that your project contains guides under the guides folder.

    +
    +
    +
    +
    .
+└── guides
+    ├── gs-guide1
+    ├── gs-guide2
+    └── gs-guide3
    +
    +
    +
    +

    This means that the project contains 3 guides that would +correspond to the following guides in Spring Guides org.

    +
    +
    + +
    +
    +

    If you deploy your project with the -Pguides profile like this

    +
    +
    +
    +
    $ ./mvnw clean deploy -Pguides
    +
    +
    +
    +

    what will happen is that for GA project versions, we will clone gs-guide1, gs-guide2 and gs-guide3 and update their contents with the ones being under your guides project.

    +
    +
    +

    You can skip this by either not adding the guides profile, or passing the -DskipGuides system property when the profile is turned on.

    +
    +
    +
    diff --git a/update-guides.sh b/update-guides.sh new file mode 100644 index 00000000..def8399c --- /dev/null +++ b/update-guides.sh @@ -0,0 +1,149 @@ +#!/bin/bash + +set -e + +GIT_BIN="${GIT_BIN:-git}" + +echo "Project version is [${PROJECT_VERSION}]" +if [[ "${PROJECT_VERSION}" != *"RELEASE"* ]];then + echo "Will not update guides, since the version is not a RELEASE one" + exit 0 +fi + +# The script should be executed from the root folder +[[ -z "${ROOT_FOLDER}" ]] && ROOT_FOLDER="$( pwd )" +echo "Current folder is ${ROOT_FOLDER}" + +if [[ ! -e "${ROOT_FOLDER}/.git" ]]; then + echo "You're not in the root folder of the project!" + exit 1 +fi + +GUIDES_FOLDER="${ROOT_FOLDER}/guides" +SPRING_GUIDES_REPO_ROOT="${SPRING_GUIDES_REPO_ROOT:-git@github.com:spring-guides}" +echo "The Spring Guides repo root is [${SPRING_GUIDES_REPO_ROOT}]" + +if [[ ! -d "${GUIDES_FOLDER}" ]]; then + echo "No [guides] folder is present. Won't do anything" + exit 0 +fi + +function iterate_over_guides() { + for dir in "${GUIDES_FOLDER}"/*/ # list directories in the form "/tmp/dirname/" + do + local dir="${dir%*/}" # remove the trailing "/" + local folderName="${dir##*/}" # print everything after the final "/" + if [[ "${folderName}" == "target" ]]; then + echo "Skipping [${folderName}]" + continue + fi + local guideRepo="${SPRING_GUIDES_REPO_ROOT}/${folderName}" + local clonedGuideFolderParent="${ROOT_FOLDER}/target" + local clonedGuideFolder="${clonedGuideFolderParent}/${folderName}" + echo "Will clone [${guideRepo}] project [${folderName}] to target" + mkdir -p "${clonedGuideFolder}" + rm -rf "${clonedGuideFolder}" + "${GIT_BIN}" clone "${guideRepo}" "${clonedGuideFolder}" + pushd "${clonedGuideFolder}" + echo "Will start the commit process for [${folderName}]" + add_oauth_token_to_remote_url + remove_all_files + copy_new_guide "${GUIDES_FOLDER}/${folderName}" "${clonedGuideFolderParent}" + commit_and_push_new_guide_contents + echo "Successfully copied and pushed new guides for [${guideRepo}]" + popd + done +} + +function commit_and_push_new_guide_contents() { + "${GIT_BIN}" add . + "${GIT_BIN}" commit -m "Updating guides" + "${GIT_BIN}" push origin master +} + +function copy_new_guide() { + local guideFolder="${1}" + local clonedGuideFolder="${2}" + echo "Will copy new guide files from [${guideFolder}/] to [${clonedGuideFolder}]" + cp -r "${guideFolder}/" "${clonedGuideFolder}/" + echo "Copied new guide files" +} + +function remove_all_files() { + echo "Removing all non git files in [$( pwd )]" + "${GIT_BIN}" rm -rf "$( pwd )/" + "${GIT_BIN}" clean -fxd + echo "All files removed" +} + +# Adds the oauth token if present to the remote url +function add_oauth_token_to_remote_url() { + local remote + remote="$( "${GIT_BIN}" config remote.origin.url | sed -e 's/^git:/https:/' )" + echo "Current remote [${remote}]" + if [[ "${RELEASER_GIT_OAUTH_TOKEN}" != "" && ${remote} != *"@"* ]]; then + echo "OAuth token found. Will reuse it to push the code" + withToken=${remote/https:\/\//https://${RELEASER_GIT_OAUTH_TOKEN}@} + "${GIT_BIN}" remote set-url --push origin "${withToken}" + else + echo "No OAuth token found" + "${GIT_BIN}" remote set-url --push origin "$( "${GIT_BIN}" config remote.origin.url | sed -e 's/^git:/https:/' )" + fi +} + +# Prints the usage +function print_usage() { +cat <