From 0168533c5c3c21ad8a7fde67573b6cf6f91b6952 Mon Sep 17 00:00:00 2001 From: Mark Lewis Date: Fri, 13 Dec 2019 17:40:06 +0000 Subject: [PATCH] FABN-1039: Fix master branch doc publishing Signed-off-by: Mark S. Lewis --- docs/jsdoc.json | 4 +-- scripts/ci_scripts/azurePublishApiDocs.sh | 37 +++++++++++------------ 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/docs/jsdoc.json b/docs/jsdoc.json index 4330b86042..24d2336695 100644 --- a/docs/jsdoc.json +++ b/docs/jsdoc.json @@ -15,10 +15,10 @@ }, "opts": { "tutorials": "docs/tutorials", - "destination": "docs/gen/master" + "destination": "docs/gen" }, "templates": { "systemName": "Hyperledger Fabric SDK for node.js", "theme": "cosmo" } -} \ No newline at end of file +} diff --git a/scripts/ci_scripts/azurePublishApiDocs.sh b/scripts/ci_scripts/azurePublishApiDocs.sh index f2cbc1d4bb..3214290228 100755 --- a/scripts/ci_scripts/azurePublishApiDocs.sh +++ b/scripts/ci_scripts/azurePublishApiDocs.sh @@ -17,7 +17,9 @@ set -e -o pipefail readonly COMMIT_HASH=$(git rev-parse HEAD) readonly BUILD_DIR="${PROJECT_DIR}/docs/gen" +readonly TEMPLATE_DIR="${PROJECT_DIR}/docs/redirectTemplates" readonly DOCS_BRANCH='gh-pages' +readonly STAGING_RELEASE_DIR="${STAGING_DIR}/${SOURCE_BRANCH}" prepareStaging() { echo "Preparing staging directory: ${STAGING_DIR}" @@ -39,23 +41,12 @@ _stagingGitSetUp() { buildDocs() { echo "Building documentation for ${SOURCE_BRANCH} branch in ${BUILD_DIR}" rm -rf "${BUILD_DIR}" - BUILD_BRANCH="${SOURCE_BRANCH}" DOCS_ROOT="${BUILD_DIR}" npm run docs -} - -copyToStaging() { - echo "Copying built documentation from ${BUILD_DIR} to ${STAGING_DIR}" - rsync -r "${BUILD_DIR}/" "${STAGING_DIR}" + npm run docs } cleanStaging() { - local releaseDir targetDir - # Remove release sub-directories that have been re-built - find "${BUILD_DIR}" -type d -maxdepth 1 -mindepth 1 -print | while read -r subdir; do - releaseDir=$(basename "${subdir}") - targetDir="${STAGING_DIR}/${releaseDir}" - echo "Removing ${targetDir}" - rm -rf "${targetDir}" - done + echo "Removing ${STAGING_RELEASE_DIR}" + rm -rf "${STAGING_RELEASE_DIR}" if [[ ${SOURCE_BRANCH} = master ]]; then removeStagingRootFiles @@ -63,11 +54,19 @@ cleanStaging() { } removeStagingRootFiles() { - local rootFile - find "${STAGING_DIR}" -type f -maxdepth 1 -mindepth 1 -print | while read -r rootFile; do - echo "Removing ${rootFile}" - rm -f "${rootFile}" - done + find "${STAGING_DIR}" -type f -maxdepth 1 -mindepth 1 \ + -exec echo Removing {} \; \ + -exec rm -f {} \; +} + +copyToStaging() { + echo "Copying built documentation from ${BUILD_DIR} to ${STAGING_RELEASE_DIR}" + rsync -r "${BUILD_DIR}/" "${STAGING_RELEASE_DIR}" + + if [[ ${SOURCE_BRANCH} = master ]]; then + echo "Copying template files from ${TEMPLATE_DIR} to ${STAGING_DIR}" + rsync -r "${TEMPLATE_DIR}/" "${STAGING_DIR}" + fi } publishDocs() {