store artifacts, fix copying and other fixes (#13)

* store artifcts

* fix copying and links

Author: trevor-coleman

src/commands/copy_docs_to_target.yml

@@ -11,6 +11,9 @@ steps:
       name: "Move static content to appropriate folder"
       command: <<include(scripts/move_static_content.sh)>>
   - run:
-      name: "Create _project_.json"
-      command: <<include(scripts/create_project_json.sh)>>
-
+      name: "Create _category_.json"
+      command: <<include(scripts/create_category_json.sh)>>
+  - store_artifacts:
+      path: ./target/docs
+  - store_artifacts:
+      path: ./target/static

src/jobs/build_docs.yml

@@ -8,7 +8,11 @@ parameters:
   source_docs_dir:
     type: string
     default: "docs"
-    description: "The path to the ir-docs folder in the repository. Defaults to './ir-docs'."
+    description: "The path to the ir-docs folder in the repository. Defaults to './docs'."
+  target_docs_dir:
+    type: string
+    default: "docs"
+    description: "The path to the ir-docs folder in the repository. Defaults to './docs'."
   label:
     type: string
     default: ""
@@ -56,6 +60,7 @@ steps:
         SOURCE_DOCS_DIR: <<parameters.source_docs_dir>>
         SOURCE_REPO_DIRECTORY_PARAM: <<parameters.source_repo_directory>>
         TARGET_REPO: <<parameters.target_repo>>
+        TARGET_DOCS_DIR: <<parameters.target_docs_dir>>
         TARGET_REPO_DIRECTORY_PARAM: <<parameters.target_repo_directory>>
       command: <<include(scripts/log_env_vars.sh)>>
   - clone_required_repos

src/scripts/clone_required_repos.sh

@@ -28,8 +28,8 @@ AddGithubToKnownHosts() {
 
 # Function to clone the source repository
 CloneSourceRepo() {
-  echo "Cloning source repository from $CIRCLE_REPOSITORY_URL to $SOURCE_REPO_DIRECTORY"
-  git clone "$CIRCLE_REPOSITORY_URL" "$SOURCE_REPO_DIRECTORY" || { echo "Failed to clone source repository"; exit 1; }
+  echo "Cloning the $CIRCLE_BRANCH branch of source repository ($CIRCLE_REPOSITORY_URL) to $SOURCE_REPO_DIRECTORY"
+  git clone --branch "$CIRCLE_BRANCH" "$CIRCLE_REPOSITORY_URL" "$SOURCE_REPO_DIRECTORY" || { echo "Failed to clone source repository"; exit 1; }
 }
 
 # Function to clone the target repository

src/scripts/copy_docs.sh

@@ -2,7 +2,15 @@
 
 CopyDocs() {
   echo "Copying documents to the target repository."
-  cp -R "$FULL_SOURCE_DOCS_PATH" "$TARGET_REPO_DIRECTORY/$TARGET_DOCS_PATH/$PROJECT_NAME"
+  echo "Source: $FULL_SOURCE_DOCS_PATH"
+  echo "Destination: $FULL_TARGET_DOCS_PATH"
+
+  echo "Files to be copied:"
+  # Log the list of files to be copied
+  find "$FULL_SOURCE_DOCS_PATH" -type f -print
+  echo "----"
+  echo "Copying files..."
+  cp -R "$FULL_SOURCE_DOCS_PATH" "$FULL_TARGET_DOCS_PATH/$PROJECT_NAME"
   echo "Documents copied successfully."
 }
 

src/scripts/create_project_json.sh renamed to src/scripts/create_category_json.sh

@@ -2,26 +2,31 @@
 
 # Assumes LABEL, DESCRIPTION, TARGET_REPO_DIRECTORY, and PROJECT_NAME are environment variables
 
-CreateProjectJSONFromTemplate() {
+CreateCategoryJSON() {
     # Ensure the target directory exists
     mkdir -p "$TARGET_REPO_DIRECTORY/docs/$PROJECT_NAME/"
 
     # Inlined template with placeholders
     # shellcheck disable=SC2016
-    TEMPLATE='{"label": "${LABEL}","description": "${DESCRIPTION}", "projectName":"${PROJECT_NAME}"}'
+    TEMPLATE='{"label": "${LABEL}","link": {"type": "generated-index","title": "${LABEL}"},"customProps": {"description": "${DESCRIPTION}", "projectName":"${PROJECT_NAME}"}}'
 
 # Substitute the variables in the template and write to target location
     echo "$TEMPLATE" | sed \
         -e "s/\${LABEL}/$LABEL/" \
         -e "s/\${DESCRIPTION}/$DESCRIPTION/" \
         -e "s/\${PROJECT_NAME}/$PROJECT_NAME/" \
-        > "$TARGET_REPO_DIRECTORY/docs/$PROJECT_NAME/_project_.json"
+        > "$TARGET_REPO_DIRECTORY/docs/$PROJECT_NAME/_category_.json"
 
     echo "_project_.json file created successfully."
 }
 
 # Check for bats
 ORB_TEST_ENV="bats-core"
 if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
-    CreateProjectJSONFromTemplate
+    CreateCategoryJSON
 fi
+
+
+
+
+

src/scripts/log_env_vars.sh

@@ -2,12 +2,14 @@
 
 # Construct paths with $CIRCLE_WORKING_DIRECTORY
 FULL_SOURCE_DOCS_PATH=$(eval echo "${CIRCLE_WORKING_DIRECTORY}/${SOURCE_REPO_DIRECTORY_PARAM}/${SOURCE_DOCS_DIR}")
+FULL_TARGET_DOCS_PATH=$(eval echo "${CIRCLE_WORKING_DIRECTORY}/${TARGET_REPO_DIRECTORY_PARAM}/${TARGET_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
   echo "export FULL_SOURCE_DOCS_PATH=\"${FULL_SOURCE_DOCS_PATH}\""
+  echo "export FULL_TARGET_DOCS_PATH=\"${FULL_TARGET_DOCS_PATH}\""
   echo "export SOURCE_REPO_DIRECTORY=\"${SOURCE_REPO_DIRECTORY}\""
   echo "export TARGET_REPO_DIRECTORY=\"${TARGET_REPO_DIRECTORY}\""
   echo "export DESCRIPTION=\"${DESCRIPTION}\""
@@ -22,6 +24,7 @@ TARGET_REPO_DIRECTORY=$(eval echo "${CIRCLE_WORKING_DIRECTORY}/${TARGET_REPO_DIR
 # Log Environment Variables
 echo "DESCRIPTION: ${DESCRIPTION}"
 echo "FULL_SOURCE_DOCS_PATH: ${FULL_SOURCE_DOCS_PATH}"
+echo "FULL_TARGET_DOCS_PATH: ${FULL_TARGET_DOCS_PATH}"
 echo "GIT_EMAIL: ${GIT_EMAIL}"
 echo "GIT_USERNAME: ${GIT_USERNAME}"
 echo "LABEL: ${LABEL}"

src/scripts/validate_param.sh

@@ -5,6 +5,7 @@ ValidateParam() {
     echo "Error: Missing parameter"
     exit 1
   fi
+  echo "Param is set correctly"
 }
 
 ORB_TEST_ENV="bats-core"