chore: rework gh-pages generation

Signed-off-by: BRIAN GLEESON <Brian.Gleeson@ie.ibm.com>

Author: briangleeson

.github/workflows/publish.yml

@@ -35,12 +35,21 @@ jobs:
       pages: write
 
     steps:
-      - name: Checkout code
+      - name: Checkout main branch
         uses: actions/checkout@v4
         with:
+          path: main
           persist-credentials: true
           fetch-depth: 0
 
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          path: gh-pages
+          persist-credentials: true
+          ref: gh-pages
+
       - name: Set up Java 11
         uses: actions/setup-java@v4
         with:

build/publishJavadoc-gha.sh

@@ -6,30 +6,42 @@ set -e
 # GITHUB_REPO_SLUG
 # GITHUB_TAG
 
+printf "\n>>>>> [DEBUG] current dir...\n"
+pwd
+ls -la
+printf "\n>>>>> [/DEBUG] current dir...\n"
+
 printf "\n>>>>> Publishing javadoc for release build: repo=%s tag=%s\n" ${GITHUB_REPO_SLUG} ${GITHUB_TAG}
 
-printf "\n>>>>> Checking out gh-pages branch...\n"
-git config --global user.email "github-actions[bot]@users.noreply.github.com"
-git config --global user.name "github-actions[bot]"
-# Checkout the gh-pages branch as a fresh copy of latest in main
-git checkout -b gh-pages --no-guess
-git status
-printf "\n>>>>> Finished checking out...\n"
+# printf "\n>>>>> Checking out gh-pages branch...\n"
+# git config --global user.email "github-actions[bot]@users.noreply.github.com"
+# git config --global user.name "github-actions[bot]"
+# # Checkout the gh-pages branch as a fresh copy of latest in main
+# git checkout -b gh-pages --no-guess
+# git status
+# printf "\n>>>>> Finished checking out...\n"
+
+# Open the "main" dir, containing the checked out main branch
+pushd main
 
 printf "\n>>>>> Generating Javadoc...\n"
 mvn -B versions:set -DnewVersion="${GITHUB_TAG}" -DgenerateBackupPoms=false
 mvn clean javadoc:aggregate --settings build/.github.settings.xml
 printf "\n>>>>> Finished generating Javadoc...\n"
 
-printf "\n>>>>> [DEBUG] current dir contents...\n"
+printf "\n>>>>> [DEBUG] ls -la...\n"
 ls -la
-printf "\n>>>>> [/DEBUG] current dir contents...\n"
+printf "\n>>>>> [/DEBUG] ls -la...\n"
 
 # Create a new directory for this branch/tag and copy the javadocs there.
 printf "\n>>>>> Copying javadocs to new directory: docs/%s\n" ${GITHUB_TAG}
-rm -rf docs/${GITHUB_TAG}
-mkdir -p docs/${GITHUB_TAG}
-cp -rf target/site/apidocs/* docs/${GITHUB_TAG}
+rm -rf ../gh-pages/docs/${GITHUB_TAG}
+mkdir -p ../gh-pages/docs/${GITHUB_TAG}
+cp -rf target/site/apidocs/* ../gh-pages/docs/${GITHUB_TAG}
+
+# Return to root dir, then open "gh-pages" dir
+popd 
+pushd gh-pages
 
 printf "\n>>>>> Generating gh-pages index.html...\n"
 build/generateJavadocIndex.sh > index.html
@@ -42,4 +54,6 @@ printf "\n>>>>> Committed changes...\n"
 git push -f origin gh-pages
 printf "\n>>>>> Pushed changes...\n"
 
+popd
+
 printf "\n>>>>> Published javadoc for release build: repo=%s tag=%s\n"  ${GITHUB_REPO_SLUG} ${GITHUB_TAG}