scripts/bash/npm-helpers/npm_push_doc.sh

@@ -111,16 +111,6 @@ else
   git push origin "HEAD:main"
 fi
 
-if [ ${FINAL_MERGE} -eq 1 ]; then
-  DOC_URL="${PROJECT_URL}/-/wikis/home"
-else
-  DOC_URL="${PROJECT_URL}/-/wikis/non-stable/${FEATURE_BRANCH_NAME}/home"
-fi
-
 perform_wiki_cleanup "${WIKI_REPO_DIR}/non-stable" "${PROJECT_URL}"
 
-echo "Documentation is available at url: ${DOC_URL}"
-
 popd
-
-echo GEN_DOC_URL="${DOC_URL}" > "gen_doc.env"

scripts/bash/npm-helpers/npm_set_doc_url.sh

+#!/bin/bash
+set -xe
+
+PROJECT_DIR="${1:?Missing arg #1 specifying a project source directory}"
+PROJECT_URL="${2:?Missing arg #2 pointing project url. It is provided by CI_PROJECT_URL variable}"
+FEATURE_BRANCH_NAME="${3:?Missing arg #3 pointing a branch name}"
+FINAL_MERGE="${4:?Missing arg #4 pointing the final merge flag value}"
+REPLACE_ENV_NAME="${5:-GEN_DOC_URL}"
+REPLACE_FILE_PATH="${6:-${PROJECT_DIR}/README.md}"
+
+pushd "${PROJECT_DIR}"
+
+if [ "${FINAL_MERGE}" = "true" ]; then
+  FINAL_MERGE=1
+else
+  FINAL_MERGE=0
+fi
+
+if [ ${FINAL_MERGE} -eq 1 ]; then
+  DOC_URL="${PROJECT_URL}/-/wikis/home"
+else
+  DOC_URL="${PROJECT_URL}/-/wikis/non-stable/${FEATURE_BRANCH_NAME}/home"
+fi
+
+echo "Documentation url: ${DOC_URL}"
+
+sed -i "s<\${${REPLACE_ENV_NAME}}<${DOC_URL}<g" "${REPLACE_FILE_PATH}"
+if grep -q "\${${REPLACE_ENV_NAME}}" "${REPLACE_FILE_PATH}"; then
+  echo "Failed to replace the documentation url in ${REPLACE_FILE_PATH}"
+  exit 1;
+fi # Ensure that the placeholder was replaced
+
+echo "Replaced the documentation url: \"\${${REPLACE_ENV_NAME}}\" => \"${DOC_URL}\" in file: \"${REPLACE_FILE_PATH}\""
+
+popd
+
+echo ${REPLACE_ENV_NAME}="${DOC_URL}" > "gen_doc.env"

templates/npm_projects.gitlab-ci.yml

@@ -3,7 +3,7 @@ include:
 
 variables:
   # uses registry.gitlab.syncad.com/hive/common-ci-configuration/emsdk:4.0.1-2
-  EMSCRIPTEN_IMAGE_TAG: "4.0.1-2@sha256:d0c5fbd811ef2447fdf411ee1e2a111c50ad0ec610cf3d6bf2d186530bc883ad"
+  EMSCRIPTEN_IMAGE_TAG: "4.0.1-2@sha256:85a53a0be347f8a7df93c34d5716620814b132260b9ba79df287b2543353d3d5"
   EMSCRIPTEN_IMAGE: "registry.gitlab.syncad.com/hive/common-ci-configuration/emsdk:$EMSCRIPTEN_IMAGE_TAG"
 
 .node_based_job_base:
@@ -217,6 +217,30 @@ variables:
       when: manual
       allow_failure: true
 
+.npm_generate_doc_url:
+  extends: .npm_based_job_base
+  variables:
+    # The directory containing sources to be built - it can be overrided by derived job
+    SOURCE_DIR: "${CI_PROJECT_DIR}"
+    PROJECT_URL: "${CI_PROJECT_URL}"
+    REPLACE_ENV_NAME: "GEN_DOC_URL"
+    REPLACE_FILE_PATH: "${SOURCE_DIR}/README.md"
+
+  before_script:
+    # start always at project root dir, to make sure .env file (included in artifacts) is generated there
+    - cd "${CI_PROJECT_DIR}"
+    - /home/emscripten/scripts/npm_set_doc_url.sh "${SOURCE_DIR}" "${PROJECT_URL}" "${CI_COMMIT_REF_NAME}" "${CI_COMMIT_REF_PROTECTED}" "${REPLACE_ENV_NAME}" "${REPLACE_FILE_PATH}"
+
+  artifacts:
+    paths:
+      - "${REPLACE_FILE_PATH}"
+    reports:
+      dotenv:
+        - "gen_doc.env"  # contains URL to generated documentation pointed by `GEN_DOC_URL` variable
+
+    when: always
+    expire_in: 1 week
+
 # Allows to store generated documentation files inside a wiki repo specific to given project. Wiki repo must be explicitly created before using this job.
 # Documentation files coming to protected branches are committed into root directory in the wiki repo. All other changes are pushed into non-stable/<branch-name> subdirectory what allows to render them by wiki.
 .npm_push_doc_template:
@@ -232,14 +256,5 @@ variables:
     DIST_DIR: "$CI_PROJECT_DIR/dist"
 
   script:
-    # start always at project root dir, to make sure .env file (included in artifacts) is generated there
     - cd "${CI_PROJECT_DIR}"
     - /home/emscripten/scripts/npm_push_doc.sh "${SOURCE_DIR}" "${PROJECT_URL}" "${WIKI_PUSH_TOKEN}" "${DIST_DIR}" "${CI_COMMIT_REF_NAME}" "${CI_COMMIT_REF_PROTECTED}"
-
-  artifacts:
-    reports:
-      dotenv:
-        - "gen_doc.env"  # contains URL to generated documentation pointed by `GEN_DOC_URL` variable
-
-    when: always
-    expire_in: 1 week