Fix parsing of repo / commit info (#34)

* verbose logs

* check for bats

* add examples

* change testcondition

* break up parse-commit-info script

* normalize bash style

* remove obsolete function call

* add exit

* remove bash env check

* fix parsing of git info

* remove obsolete tests

Author: trevor-coleman

src/commands/commit_and_push_to_target.yml

@@ -2,9 +2,6 @@ description: >
   "Commits and pushes the updated documentation to the docs repository."
 
 steps:
-  - run:
-      name: Parse commit message and PR number
-      command: <<include(scripts/parse_commit_info.sh)>>
   - run:
       name: Commit and push to target repository
       command: <<include(scripts/commit_and_push_to_target.sh)>>

src/commands/extract_github_org_and_repo.yml

@@ -0,0 +1,6 @@
+description: >
+  "Extracts GitHub organization and repository name from the repository URL."
+steps:
+  - run:
+      name: "Extract GitHub Organization and Repository"
+      command: <<include(scripts/extract_github_org_and_repo.sh)>>

src/commands/fetch_commit_info.yml

@@ -0,0 +1,6 @@
+description: >
+  "Fetch the last commit message and commit hash from the source repository."
+steps:
+  - run:
+      name: "Fetch Commit Info"
+      command: <<include(scripts/fetch_commit_info.sh)>>

src/commands/generate_commit_message.yml

@@ -0,0 +1,6 @@
+description: >
+  "Constructs the final commit message incorporating all relevant details and links."
+steps:
+  - run:
+      name: "Generate Commit Message"
+      command: <<include(scripts/generate_commit_message.sh)>>

src/commands/normalize_repository_url.yml

@@ -0,0 +1,6 @@
+description: >
+  "Normalizes the GitHub URL for use in later parts of the script."
+steps:
+  - run:
+      name: "Normalize Repository URL"
+      command: <<include(scripts/normalize_repository_url.sh)>>

src/examples/example.yml renamed to src/examples/basic_usage.yml

@@ -0,0 +1,32 @@
+description: >
+  You can reduce repetition by defining props in a YAML anchor and referencing it later.
+
+usage:
+  version: 2.1
+  orbs:
+    publish-docs: infinitered/[email protected]  # Replace with the actual version
+
+# Define common parameters
+common_params: &publish_docs_params
+  description: "The description that will appear on autogenerated indexes and components."
+  git_email: "[email protected]"
+  git_username: "Your CI Username"
+  label: "The label that will appear in the sidebar of the docs site."
+  project_name: 'name-of-project'
+  source_docs_dir: "docs"
+  source_repo_directory: "source"
+  target_docs_dir: "docs"
+  target_repo: "[email protected]:your-org/your-repo.git"
+  target_repo_directory: "target"
+
+workflows:
+  build_docs:
+    jobs:
+      - publish-docs/build_docs:
+          # this will expand to all the parameters defined in the anchor
+          <<: *publish_docs_params
+  publish_to_docs_site:
+    jobs:
+      - publish-docs/publish_docs:
+          # this will expand to all the parameters defined in the anchor
+          <<: *publish_docs_params

src/examples/references.yml

@@ -68,4 +68,8 @@ steps:
       repo_directory: <<parameters.target_repo_directory>>
   - copy_docs_to_target
   - build_docusaurus
+  - fetch_commit_info
+  - normalize_repository_url
+  - extract_github_org_and_repo
+  - generate_commit_message
   - commit_and_push_to_target

src/jobs/publish_docs.yml

@@ -1,18 +1,19 @@
 #!/bin/bash
 
+# Function to check if documents exist in the source directory
 CheckDocsExist() {
   # Parameters: Source docs path
-  echo "Checking if documents exist in the source directory."
+  echo "Checking if documents exist in the source directory." >&2
 
   # Check if the directory exists
   if [ ! -d "$FULL_SOURCE_DOCS_PATH" ]; then
-    echo "Error: Directory $FULL_SOURCE_DOCS_PATH does not exist."
+    echo "Error: Directory $FULL_SOURCE_DOCS_PATH does not exist." >&2
     exit 1
   fi
 
   # Check if the directory is empty
   if [ ! "$(ls -A "$FULL_SOURCE_DOCS_PATH")" ]; then
-    echo "Error: No files found in docs directory."
+    echo "Error: No files found in docs directory." >&2
     exit 1
   fi
 }

src/scripts/check_docs_exist.sh

@@ -14,27 +14,27 @@ LogEnvironmentVariables() {
 
 # Function to set the Git username and email
 SetGitUser() {
-  echo "Configuring Git username and email: $GIT_USERNAME -- $GIT_EMAIL"
+  echo "Configuring Git username and email: $GIT_USERNAME -- $GIT_EMAIL" >&2
   git config --global user.name "$GIT_USERNAME" || { echo "Failed to configure Git username"; exit 1; }
   git config --global user.email "$GIT_EMAIL" || { echo "Failed to configure Git email"; exit 1; }
 }
 
 # Function to add github.com to known SSH hosts
 AddGithubToKnownHosts() {
-  echo "Adding github.com to known SSH hosts"
+  echo "Adding github.com to known SSH hosts" >&2
   mkdir -p ~/.ssh
   ssh-keyscan github.com >> ~/.ssh/known_hosts || { echo "Failed to add github.com to known hosts"; exit 1; }
 }
 
 # Function to clone the source repository
 CloneSourceRepo() {
-  echo "Cloning the $CIRCLE_BRANCH branch of source repository ($CIRCLE_REPOSITORY_URL) to $SOURCE_REPO_DIRECTORY"
+  echo "Cloning the $CIRCLE_BRANCH branch of source repository ($CIRCLE_REPOSITORY_URL) to $SOURCE_REPO_DIRECTORY" >&2
   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
 CloneTargetRepo() {
-  echo "Cloning target repository from $TARGET_REPO to $TARGET_REPO_DIRECTORY"
+  echo "Cloning target repository from $TARGET_REPO to $TARGET_REPO_DIRECTORY" >&2
   git clone "$TARGET_REPO" "$TARGET_REPO_DIRECTORY" || { echo "Failed to clone target repository"; exit 1; }
   ls "$TARGET_REPO_DIRECTORY"
 }
@@ -43,12 +43,10 @@ CloneTargetRepo() {
 ORB_TEST_ENV="bats-core"
 if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
   LogEnvironmentVariables
-  echo "Script is being executed directly"
+  echo "Script is being executed directly" >&2
 
   SetGitUser
   AddGithubToKnownHosts
   CloneSourceRepo
   CloneTargetRepo
-else
-  echo "Script is being sourced"
 fi