diff --git a/docs/src/main/asciidoc/ghpages.sh b/docs/src/main/asciidoc/ghpages.sh index 7d14c9af..8a01a031 100755 --- a/docs/src/main/asciidoc/ghpages.sh +++ b/docs/src/main/asciidoc/ghpages.sh @@ -33,7 +33,7 @@ Please migrate to the new approach as soon as possible since this script will be EOF -# The script should be executed from the root folder +# The script should be run from the root folder ROOT_FOLDER="$( pwd )" echo "Current folder is [${ROOT_FOLDER}]" echo "Spring Cloud Static repo is [${SPRING_CLOUD_STATIC_REPO_DESTINATION}]" @@ -135,23 +135,23 @@ function build_docs_if_applicable() { } # Get the name of the `docs.main` property -# Get whitelisted branches - assumes that a `docs` module is available under `docs` profile +# Get allowed branches - assumes that a `docs` module is available under `docs` profile # shellcheck disable=SC2016 function retrieve_doc_properties() { if [[ "${RELEASE_TRAIN}" == "yes" ]]; then echo "Will not extract any properties for release train" - return + return fi - WHITELIST_PROPERTY=${WHITELIST_PROPERTY:-"docs.whitelisted.branches"} - WHITELISTED_BRANCHES_VALUE=$("${MAVEN_EXEC}" -q \ + ALLOW_PROPERTY=${ALLOW_PROPERTY:-"docs.allowed.branches"} + ALLOWED_BRANCHES_VALUE=$("${MAVEN_EXEC}" -q \ -Dexec.executable="echo" \ - -Dexec.args="\${${WHITELIST_PROPERTY}}" \ + -Dexec.args="\${${ALLOW_PROPERTY}}" \ org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \ -P docs \ -pl docs | tail -1 ) - echo "Extracted '${WHITELIST_PROPERTY}' from Maven build [${WHITELISTED_BRANCHES_VALUE}]" + echo "Extracted '${ALLOW_PROPERTY}' from Maven build [${ALLOWED_BRANCHES_VALUE}]" } # Stash any outstanding changes @@ -238,9 +238,9 @@ function copy_docs_for_current_version() { else echo -e "Current branch is [${CURRENT_BRANCH}]" # https://stackoverflow.com/questions/29300806/a-bash-script-to-check-if-a-string-is-present-in-a-comma-separated-list-of-strin - if [[ ",${WHITELISTED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then + if [[ ",${ALLOWED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then mkdir -p "${ROOT_FOLDER}/${CURRENT_BRANCH}" - echo -e "Branch [${CURRENT_BRANCH}] is whitelisted! Will copy the current docs to the [${CURRENT_BRANCH}] folder" + echo -e "Branch [${CURRENT_BRANCH}] is allowed! Will copy the current docs to the [${CURRENT_BRANCH}] folder" for f in docs/target/generated-docs/*; do file="${f#docs/target/generated-docs/*}" if ! "${GIT_BIN}" ls-files -i -o --exclude-standard --directory | grep -q ^"${file}"$; then @@ -253,7 +253,7 @@ function copy_docs_for_current_version() { done COMMIT_CHANGES="yes" else - echo -e "Branch [${CURRENT_BRANCH}] is not on the white list! Check out the Maven [${WHITELIST_PROPERTY}] property in + echo -e "Branch [${CURRENT_BRANCH}] is not on the allow list! Check out the Maven [${ALLOW_PROPERTY}] property in [docs] module available under [docs] profile. Won't commit any changes to gh-pages for this branch." fi fi @@ -329,10 +329,10 @@ the script will work in the following manner: - if there's no gh-pages / target for docs module then the script ends - for master branch the generated docs are copied to the root of gh-pages branch -- for any other branch (if that branch is whitelisted) a subfolder with branch name is created +- for any other branch (if that branch is allowed) a subfolder with branch name is created and docs are copied there - if the version switch is passed (-v) then a tag with (v) prefix will be retrieved and a folder - 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 allow 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 switch to gh-pages of that repo and copy the generated docs to [docs//] - if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will diff --git a/docs/src/main/asciidoc/update-guides.sh b/docs/src/main/asciidoc/update-guides.sh index e575ee2c..6dbefd6a 100755 --- a/docs/src/main/asciidoc/update-guides.sh +++ b/docs/src/main/asciidoc/update-guides.sh @@ -10,7 +10,7 @@ if [[ "${PROJECT_VERSION}" != *"RELEASE"* ]];then exit 0 fi -# The script should be executed from the root folder +# The script should be run from the root folder [[ -z "${ROOT_FOLDER}" ]] && ROOT_FOLDER="$( pwd )" echo "Current folder is ${ROOT_FOLDER}" @@ -146,4 +146,3 @@ else iterate_over_guides fi -