Fix env vars (#5)

* fix env-vars

* rename var in test

* fix failing test

* empty commit

Author: trevor-coleman

scripts/pack-and-publish.sh

@@ -4,10 +4,19 @@ PackAndPublish() {
   project_root="$(dirname "$(dirname "${BASH_SOURCE[0]}")")"
   source_path="$project_root/src"
   output_path="$project_root/orb.yml"
-   rm -f "$output_path"
-   circleci orb pack "$source_path" > "$output_path"
-   circleci orb validate "$output_path" || { echo "Orb validation failed"; exit 1; }
-   circleci orb publish "$output_path" "infinitered/publish-docs@dev:alpha"
+
+  # Default version suffix
+  version_suffix="alpha"
+
+  # Check if an argument is provided
+  if [ "$#" -gt 0 ]; then
+    version_suffix="$1"
+  fi
+
+  rm -f "$output_path"
+  circleci orb pack "$source_path" > "$output_path"
+  circleci orb validate "$output_path" || { echo "Orb validation failed"; exit 1; }
+  circleci orb publish "$output_path" "infinitered/publish-docs@dev:$version_suffix"
 }
 
-PackAndPublish
+PackAndPublish "$@"

src/commands/install_and_cache_yarn_dependencies.yml

@@ -1,25 +1,23 @@
 description: "Install Yarn dependencies and cache them."
 parameters:
-  working_directory:
+  repo_directory:
     type: string
-    default: ""
-    description: "The working directory where the repository is cloned."
+    default: "./"
+    description: "The directory for repository operations."
 steps:
-  - run:
-      name: Compute checksum
-      command: echo 'export YARN_LOCK_CHECKSUM=$(checksum $TARGET_REPO_DIRECTORY/yarn.lock)' >> $BASH_ENV
   - restore_cache:
       name: Restore Yarn Cache
       keys:
-        - yarn-cache-$TARGET_REPO_DIRECTORY-{{ .Environment.YARN_LOCK_CHECKSUM }}
+        - yarn-cache-<< parameters.repo_directory >>-{{ checksum "<< parameters.repo_directory >>/yarn.lock" }}
   - run:
       name: Use local Yarn version
       command: <<include(scripts/use_local_yarn_version.sh)>>
   - run:
       name: Install Dependencies
+      working_directory: << parameters.repo_directory >>
       command: yarn install --immutable
   - save_cache:
       name: Save Yarn Cache
-      key: yarn-cache-$TARGET_REPO_DIRECTORY-{{ .Environment.YARN_LOCK_CHECKSUM }}
+      key: yarn-cache-<< parameters.repo_directory >>-{{ checksum "<< parameters.repo_directory >>/yarn.lock" }}
       paths:
-        - $TARGET_REPO_DIRECTORY/.yarn/cache
+        - << parameters.repo_directory >>/.yarn/cache

src/jobs/build_docs.yml

@@ -60,6 +60,6 @@ steps:
       command: <<include(scripts/log_env_vars.sh)>>
   - clone_required_repos
   - install_and_cache_yarn_dependencies:
-      working_directory: <<parameters.target_repo_directory>>
+      repo_directory: <<parameters.target_repo_directory>>
   - copy_docs_to_target
   - build_docusaurus

src/scripts/check_docs_exist.sh

@@ -1,23 +1,24 @@
-#! /bin/bash
-
+#!/bin/bash
 
 CheckDocsExist() {
   # Parameters: Source docs path
   echo "Checking if documents exist in the source directory."
 
   # Check if the directory exists
-  if [ ! -d "$SOURCE_DOCS_PATH" ]; then
-    echo "Error: Directory $SOURCE_DOCS_PATH does not exist."
+  if [ ! -d "$FULL_SOURCE_DOCS_PATH" ]; then
+    echo "Error: Directory $FULL_SOURCE_DOCS_PATH does not exist."
     exit 1
   fi
 
   # Check if the directory is empty
-  if [ ! "$(ls -A "$SOURCE_DOCS_PATH")" ]; then
+  if [ ! "$(ls -A "$FULL_SOURCE_DOCS_PATH")" ]; then
     echo "Error: No files found in docs directory."
     exit 1
   fi
 }
 
-if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+ORB_TEST_ENV="bats-core"
+if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
+  # shellcheck source=/dev/null
   CheckDocsExist
 fi

src/scripts/clone_required_repos.sh

@@ -1,4 +1,16 @@
-#! /bin/bash
+#!/bin/bash
+
+# Function to log environment variables
+LogEnvironmentVariables() {
+  echo "Logging Environment Variables:"
+  echo "CIRCLE_REPOSITORY_URL: $CIRCLE_REPOSITORY_URL"
+  echo "SOURCE_REPO_DIRECTORY: $SOURCE_REPO_DIRECTORY"
+  echo "TARGET_REPO: $TARGET_REPO"
+  echo "TARGET_REPO_DIRECTORY: $TARGET_REPO_DIRECTORY"
+  echo "GIT_USERNAME: $GIT_USERNAME"
+  echo "GIT_EMAIL: $GIT_EMAIL"
+  echo "-----------------------------"
+}
 
 # Function to set the Git username and email
 SetGitUser() {
@@ -24,12 +36,19 @@ CloneSourceRepo() {
 CloneTargetRepo() {
   echo "Cloning target repository from $TARGET_REPO to $TARGET_REPO_DIRECTORY"
   git clone "$TARGET_REPO" "$TARGET_REPO_DIRECTORY" || { echo "Failed to clone target repository"; exit 1; }
+  ls "$TARGET_REPO_DIRECTORY"
 }
 
 # Check if the script is being sourced or executed directly
-if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+ORB_TEST_ENV="bats-core"
+if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
+  LogEnvironmentVariables
+  echo "Script is being executed directly"
+
   SetGitUser
   AddGithubToKnownHosts
   CloneSourceRepo
   CloneTargetRepo
+else
+  echo "Script is being sourced"
 fi

src/scripts/commit_and_push_to_target.sh

@@ -8,6 +8,7 @@ git commit -m "\"$FINAL_COMMIT_MESSAGE\"" || { echo "Git commit failed"; exit 1;
 git push origin main || { echo "Git push failed"; exit 1; }
 }
 
-if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+ORB_TEST_ENV="bats-core"
+if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
   CommitAndPushToTarget
 fi

src/scripts/copy_docs.sh

@@ -2,11 +2,12 @@
 
 CopyDocs() {
   echo "Copying documents to the target repository."
-  cp -R "$SOURCE_DOCS_PATH" "$TARGET_REPO_DIRECTORY/$TARGET_DOCS_PATH/$PROJECT_NAME"
+  cp -R "$FULL_SOURCE_DOCS_PATH" "$TARGET_REPO_DIRECTORY/$TARGET_DOCS_PATH/$PROJECT_NAME"
   echo "Documents copied successfully."
 }
 
-if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+ORB_TEST_ENV="bats-core"
+if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
   CopyDocs
 fi
 

src/scripts/create_category_json.sh

@@ -1,22 +1,23 @@
-#! /bin/bash
-# Parameters: Project name, Label, Description
+#!/bin/bash
 
-CreateCategoryJSON() {
-  echo "Creating _category_.json file."
-  echo "
-  \{
-    \"label\": \"$LABEL\",
-    \"link\": \{
-      \"type\": \"generated-index\",
-      \"description\": \"$DESCRIPTION\"
-    \}
-  \}
-  " > "$TARGET_REPO_DIRECTORY/docs/$PROJECT_NAME/_category_.json"
+# Assumes LABEL, DESCRIPTION, TARGET_REPO_DIRECTORY, and PROJECT_NAME are environment variables
 
-  echo "_category_.json file created successfully."
+CreateCategoryJSONFromTemplate() {
+    # Inlined template with placeholders
+    # shellcheck disable=SC2016
+    TEMPLATE='{"label": "${LABEL}","link": {"type": "generated-index","description": "${DESCRIPTION}"}}'
+
+    # Substitute the variables in the template and write to target location
+    echo "$TEMPLATE" | sed \
+        -e "s/\${LABEL}/$LABEL/" \
+        -e "s/\${DESCRIPTION}/$DESCRIPTION/" \
+        > "$TARGET_REPO_DIRECTORY/docs/$PROJECT_NAME/_category_.json"
+
+    echo "_category_.json file created successfully."
 }
 
-if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
-  CreateCategoryJSON
+# Check for bats
+ORB_TEST_ENV="bats-core"
+if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
+    CreateCategoryJSONFromTemplate
 fi
-

src/scripts/docusaurus_build.sh

@@ -7,6 +7,7 @@ echo "Running Docusaurus build..."
 yarn build || { echo "Docusaurus build failed"; exit 1; }
 }
 
-if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+ORB_TEST_ENV="bats-core"
+if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
   DocusaurusBuild
 fi

src/scripts/log_env_vars.sh

@@ -1,9 +1,9 @@
-#! /bin/bash
+#!/bin/bash
 
 # Construct paths with $CIRCLE_WORKING_DIRECTORY
-FULL_SOURCE_DOCS_PATH="${CIRCLE_WORKING_DIRECTORY}/${SOURCE_REPO_DIRECTORY_PARAM}/${SOURCE_DOCS_DIR}"
-SOURCE_REPO_DIRECTORY="${CIRCLE_WORKING_DIRECTORY}/${SOURCE_REPO_DIRECTORY_PARAM}"
-TARGET_REPO_DIRECTORY="${CIRCLE_WORKING_DIRECTORY}/${TARGET_REPO_DIRECTORY_PARAM}"
+FULL_SOURCE_DOCS_PATH=$(eval echo "${CIRCLE_WORKING_DIRECTORY}/${SOURCE_REPO_DIRECTORY_PARAM}/${SOURCE_DOCS_DIR}")
+SOURCE_REPO_DIRECTORY=$(eval echo "${CIRCLE_WORKING_DIRECTORY}/${SOURCE_REPO_DIRECTORY_PARAM}")
+TARGET_REPO_DIRECTORY=$(eval echo "${CIRCLE_WORKING_DIRECTORY}/${TARGET_REPO_DIRECTORY_PARAM}")
 
 {
   # Set environment variables for subsequent steps