From c3b9c44adf4f3fe1958fdf04a8013cc30b7e88eb Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 12:51:28 +0000 Subject: [PATCH 01/14] chore: test branch for javadoc publish issue Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 5 +++-- build/publishJavadoc-gha.sh | 8 ++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 06f0fc0b..33b29413 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -31,7 +31,7 @@ jobs: if: (github.event_name == 'push' && startsWith(github.event.head_commit.message, 'chore(release):')) || (github.event_name == 'workflow_dispatch' && inputs.publish_javadoc) permissions: - contents: write + contents: read pages: write steps: @@ -52,7 +52,8 @@ jobs: - name: Publish Javadocs env: - GH_TOKEN: ${{ secrets.GH_TOKEN }} + # GH_TOKEN: ${{ secrets.GH_TOKEN }} + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_REPO_SLUG: ${{ github.repository }} GITHUB_TAG: ${{ github.ref_name}} run: | diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index bc7422ce..26460ef0 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -10,11 +10,11 @@ printf "\n>>>>> Publishing javadoc for release build: repo=%s tag=%s\n" ${GITHUB printf "\n>>>>> Cloning repository's gh-pages branch into directory 'gh-pages'\n" rm -fr ./gh-pages # TODO this approach doesnt work when using GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} in workflow -# git config --global user.email "github-actions[bot]@users.noreply.github.com" -# git config --global user.name "github-actions[bot]" -# git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages -# TODO For now using a hardcoded token in the repo settings secrets, tied to brian.gleeson@ie.ibm.com +git config --global user.email "github-actions[bot]@users.noreply.github.com" +git config --global user.name "github-actions[bot]" git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages +# TODO For now using a hardcoded token in the repo settings secrets, tied to brian.gleeson@ie.ibm.com +# git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages printf "\n>>>>> Finished cloning...\n" gh auth status From 8d9bcf2296874ce9c0f5351ace98650704a7f2d6 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 12:51:28 +0000 Subject: [PATCH 02/14] chore: test branch for javadoc publish issue Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 1 + build/publishJavadoc-gha.sh | 11 ++++++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 33b29413..3b715fb0 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -38,6 +38,7 @@ jobs: - name: Checkout code uses: actions/checkout@v4 with: + persist-credentials: true fetch-depth: 0 - name: Set up Java 11 diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index 26460ef0..4fba2b1f 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -7,20 +7,21 @@ printf "\n>>>>> Publishing javadoc for release build: repo=%s tag=%s\n" ${GITHUB_REPO_SLUG} ${GITHUB_TAG} +gh auth status + +printf "\n>>>>> Finished checking gh auth status...\n" + printf "\n>>>>> Cloning repository's gh-pages branch into directory 'gh-pages'\n" rm -fr ./gh-pages # TODO this approach doesnt work when using GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} in workflow git config --global user.email "github-actions[bot]@users.noreply.github.com" git config --global user.name "github-actions[bot]" -git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages +# git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages +git clone --branch=gh-pages https://github.com/${GITHUB_REPO_SLUG}.git gh-pages # TODO For now using a hardcoded token in the repo settings secrets, tied to brian.gleeson@ie.ibm.com # git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages printf "\n>>>>> Finished cloning...\n" -gh auth status - -printf "\n>>>>> Finished checking gh auth status...\n" - pushd gh-pages # Create a new directory for this branch/tag and copy the javadocs there. From 18c46650cdfdea3bfa01db8569f9a45dc65dfc11 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 13:00:59 +0000 Subject: [PATCH 03/14] chore: fix permissions Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 3b715fb0..a4de74c2 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -31,7 +31,7 @@ jobs: if: (github.event_name == 'push' && startsWith(github.event.head_commit.message, 'chore(release):')) || (github.event_name == 'workflow_dispatch' && inputs.publish_javadoc) permissions: - contents: read + contents: write pages: write steps: From 4f910ed299839681165a9ea50c62469a3e9262f5 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 13:08:59 +0000 Subject: [PATCH 04/14] chore: simplify javadoc script Signed-off-by: BRIAN GLEESON --- build/publishJavadoc-gha.sh | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index 4fba2b1f..2228a514 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -17,12 +17,13 @@ rm -fr ./gh-pages git config --global user.email "github-actions[bot]@users.noreply.github.com" git config --global user.name "github-actions[bot]" # git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages -git clone --branch=gh-pages https://github.com/${GITHUB_REPO_SLUG}.git gh-pages +# git clone --branch=gh-pages https://github.com/${GITHUB_REPO_SLUG}.git gh-pages +git checkout -b gh-pages origin/gh-pages # TODO For now using a hardcoded token in the repo settings secrets, tied to brian.gleeson@ie.ibm.com # git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages printf "\n>>>>> Finished cloning...\n" -pushd gh-pages +# pushd gh-pages # 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} @@ -39,9 +40,9 @@ printf "\n>>>>> Added files...\n" git commit -m "docs: latest javadoc for ${GITHUB_TAG}" printf "\n>>>>> Committed changes...\n" git remote -v -git push -f origin gh-pages +git push origin gh-pages printf "\n>>>>> Pushed changes...\n" -popd +# popd printf "\n>>>>> Published javadoc for release build: repo=%s tag=%s\n" ${GITHUB_REPO_SLUG} ${GITHUB_TAG} From acd119c9deb849b3f2261a166b3d32edbaa725cc Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 13:20:32 +0000 Subject: [PATCH 05/14] chore: debug javadoc update Signed-off-by: BRIAN GLEESON --- build/publishJavadoc-gha.sh | 13 ++----------- .../cd_tekton_pipeline/v2/CdTektonPipeline.java | 4 +++- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index 2228a514..cca14eab 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -11,19 +11,12 @@ gh auth status printf "\n>>>>> Finished checking gh auth status...\n" -printf "\n>>>>> Cloning repository's gh-pages branch into directory 'gh-pages'\n" +printf "\n>>>>> Checking out gh-pages branch...\n" rm -fr ./gh-pages -# TODO this approach doesnt work when using GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} in workflow git config --global user.email "github-actions[bot]@users.noreply.github.com" git config --global user.name "github-actions[bot]" -# git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages -# git clone --branch=gh-pages https://github.com/${GITHUB_REPO_SLUG}.git gh-pages git checkout -b gh-pages origin/gh-pages -# TODO For now using a hardcoded token in the repo settings secrets, tied to brian.gleeson@ie.ibm.com -# git clone --branch=gh-pages https://${GH_TOKEN}@github.com/${GITHUB_REPO_SLUG}.git gh-pages -printf "\n>>>>> Finished cloning...\n" - -# pushd gh-pages +printf "\n>>>>> Finished checking out...\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} @@ -43,6 +36,4 @@ git remote -v git push 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} diff --git a/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java b/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java index 7fe04a1a..4fef0b7b 100644 --- a/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java +++ b/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java @@ -79,10 +79,12 @@ import java.util.Map.Entry; /** - * Continuous Delivery Tekton pipeline API definition <br><br> Maximum request payload size is 512 KB + * Continuous Delivery Tekton Pipeline API definition <br><br> Maximum request payload size is 512 KB * <br><br> All calls require an <strong>Authorization</strong> HTTP header. * <br><br> The following header is the accepted authentication mechanism and required credentials for each * <ul><li><b>Bearer:</b> an IBM Cloud IAM token (authorized for all endpoints)</li>. + * + * DEBUGGING TEST * * API Version: 2.0.0 */ From b4566218f2b1db11aef1bba003045a5ad862b7c9 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 13:28:20 +0000 Subject: [PATCH 06/14] chore: reorder javadoc steps Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 1 - build/publishJavadoc-gha.sh | 6 +++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index a4de74c2..1b0adac1 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -58,7 +58,6 @@ jobs: GITHUB_REPO_SLUG: ${{ github.repository }} GITHUB_TAG: ${{ github.ref_name}} run: | - mvn clean javadoc:aggregate --settings build/.github.settings.xml build/publishJavadoc-gha.sh publish-maven-central: diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index cca14eab..0cc860ca 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -7,8 +7,8 @@ printf "\n>>>>> Publishing javadoc for release build: repo=%s tag=%s\n" ${GITHUB_REPO_SLUG} ${GITHUB_TAG} +printf "\n>>>>> Checking gh auth status...\n" gh auth status - printf "\n>>>>> Finished checking gh auth status...\n" printf "\n>>>>> Checking out gh-pages branch...\n" @@ -18,6 +18,10 @@ git config --global user.name "github-actions[bot]" git checkout -b gh-pages origin/gh-pages printf "\n>>>>> Finished checking out...\n" +printf "\n>>>>> Generating Javadoc...\n" +mvn clean javadoc:aggregate --settings build/.github.settings.xml +printf "\n>>>>> Finished generating Javadoc...\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} From d8571ae257d09ba2a452de1949fc45b8cf3b8071 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 13:35:13 +0000 Subject: [PATCH 07/14] chore: fix step ordering Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 3 --- build/publishJavadoc-gha.sh | 2 ++ 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 1b0adac1..4032cca2 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -48,9 +48,6 @@ jobs: distribution: 'temurin' cache: 'maven' - - name: Set artifact version to ${{ github.ref_name }} - run: mvn -B versions:set -DnewVersion=${{ github.ref_name}} -DgenerateBackupPoms=false - - name: Publish Javadocs env: # GH_TOKEN: ${{ secrets.GH_TOKEN }} diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index 0cc860ca..f5d5f9c3 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -16,9 +16,11 @@ rm -fr ./gh-pages git config --global user.email "github-actions[bot]@users.noreply.github.com" git config --global user.name "github-actions[bot]" git checkout -b gh-pages origin/gh-pages +git status printf "\n>>>>> Finished checking out...\n" 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" From 96b92eac7e33dc33ca2621d1a6bb7a33caa73130 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 13:48:33 +0000 Subject: [PATCH 08/14] chore: test different branch checkout approach Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 2 -- build/publishJavadoc-gha.sh | 7 +++++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4032cca2..75c6cce4 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -50,8 +50,6 @@ jobs: - name: Publish Javadocs env: - # GH_TOKEN: ${{ secrets.GH_TOKEN }} - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_REPO_SLUG: ${{ github.repository }} GITHUB_TAG: ${{ github.ref_name}} run: | diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index f5d5f9c3..d1871bd8 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -1,7 +1,6 @@ #!/bin/bash # Required environment variables: -# GH_TOKEN # GITHUB_REPO_SLUG # GITHUB_TAG @@ -15,12 +14,16 @@ printf "\n>>>>> Checking out gh-pages branch...\n" rm -fr ./gh-pages git config --global user.email "github-actions[bot]@users.noreply.github.com" git config --global user.name "github-actions[bot]" -git checkout -b gh-pages origin/gh-pages +# Checkout the gh-pages branch as a copy of latest in main +git checkout -b gh-pages --no-guess git status printf "\n>>>>> Finished checking out...\n" printf "\n>>>>> Generating Javadoc...\n" mvn -B versions:set -DnewVersion="${GITHUB_TAG}" -DgenerateBackupPoms=false +printf "\n>>>>> [DEBUG] build fodler contents...\n" +ls -la build +printf "\n>>>>> [/DEBUG] build fodler contents...\n" mvn clean javadoc:aggregate --settings build/.github.settings.xml printf "\n>>>>> Finished generating Javadoc...\n" From 72e029f5cf3d4716d7b44f2d5c4a59f4718ab33f Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 14:00:43 +0000 Subject: [PATCH 09/14] chore: fix file not found script issues Signed-off-by: BRIAN GLEESON --- build/publishJavadoc-gha.sh | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index d1871bd8..2be4a886 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -1,48 +1,49 @@ #!/bin/bash +set -e + # Required environment variables: # GITHUB_REPO_SLUG # GITHUB_TAG printf "\n>>>>> Publishing javadoc for release build: repo=%s tag=%s\n" ${GITHUB_REPO_SLUG} ${GITHUB_TAG} -printf "\n>>>>> Checking gh auth status...\n" +printf "\n>>>>> [DEBUG] Checking gh auth status...\n" gh auth status -printf "\n>>>>> Finished checking gh auth status...\n" +printf "\n>>>>> [DEBUG] Finished checking gh auth status...\n" printf "\n>>>>> Checking out gh-pages branch...\n" -rm -fr ./gh-pages 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 copy of latest in main +# 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>>>>> Generating Javadoc...\n" mvn -B versions:set -DnewVersion="${GITHUB_TAG}" -DgenerateBackupPoms=false -printf "\n>>>>> [DEBUG] build fodler contents...\n" -ls -la build -printf "\n>>>>> [/DEBUG] build fodler contents...\n" mvn clean javadoc:aggregate --settings build/.github.settings.xml -printf "\n>>>>> Finished generating Javadoc...\n" +printf "\n>>>>> Finished generating Javadoc...\n" + +printf "\n>>>>> [DEBUG] current dir contents...\n" +ls -la +printf "\n>>>>> [/DEBUG] current dir contents...\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} +cp -rf target/site/apidocs/* docs/${GITHUB_TAG} printf "\n>>>>> Generating gh-pages index.html...\n" -../build/generateJavadocIndex.sh > index.html +build/generateJavadocIndex.sh > index.html printf "\n>>>>> Committing new javadoc...\n" git add -f . printf "\n>>>>> Added files...\n" git commit -m "docs: latest javadoc for ${GITHUB_TAG}" printf "\n>>>>> Committed changes...\n" -git remote -v -git push origin gh-pages +git push -f origin gh-pages printf "\n>>>>> Pushed changes...\n" printf "\n>>>>> Published javadoc for release build: repo=%s tag=%s\n" ${GITHUB_REPO_SLUG} ${GITHUB_TAG} From f263935e580fe39697e79a2eae3af657f704300a Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 14:03:05 +0000 Subject: [PATCH 10/14] chore: remove gh auth check Signed-off-by: BRIAN GLEESON --- build/publishJavadoc-gha.sh | 4 ---- 1 file changed, 4 deletions(-) diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index 2be4a886..c63b1ba1 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -8,10 +8,6 @@ set -e printf "\n>>>>> Publishing javadoc for release build: repo=%s tag=%s\n" ${GITHUB_REPO_SLUG} ${GITHUB_TAG} -printf "\n>>>>> [DEBUG] Checking gh auth status...\n" -gh auth status -printf "\n>>>>> [DEBUG] Finished checking gh auth status...\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]" From 4b70de56fe65f076d900545b801d32e68943aec6 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 14:19:58 +0000 Subject: [PATCH 11/14] chore: rework gh-pages generation Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 11 +++++++++- build/publishJavadoc-gha.sh | 38 ++++++++++++++++++++++++----------- 2 files changed, 36 insertions(+), 13 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 75c6cce4..a15fd51f 100644 --- a/.github/workflows/publish.yml +++ b/.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: diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index c63b1ba1..f6ba837e 100755 --- a/build/publishJavadoc-gha.sh +++ b/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} From aaab47b9e7d85939cd6d1c4b73b93a64419215d4 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 14:37:34 +0000 Subject: [PATCH 12/14] chore: fix path locations Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 2 +- build/publishJavadoc-gha.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index a15fd51f..4057d53d 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -62,7 +62,7 @@ jobs: GITHUB_REPO_SLUG: ${{ github.repository }} GITHUB_TAG: ${{ github.ref_name}} run: | - build/publishJavadoc-gha.sh + main/build/publishJavadoc-gha.sh publish-maven-central: # Requires GPG_KEYNAME, GPG_PRIVATE_KEY, GPG_PASSPHRASE, CP_USERNAME, CP_PASSWORD diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index f6ba837e..4a403b74 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -44,7 +44,7 @@ popd pushd gh-pages printf "\n>>>>> Generating gh-pages index.html...\n" -build/generateJavadocIndex.sh > index.html +../main/build/generateJavadocIndex.sh > index.html printf "\n>>>>> Committing new javadoc...\n" git add -f . From 26b127fed447335bbed28f697931ac77b53b8294 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 14:48:07 +0000 Subject: [PATCH 13/14] chore: fix git config Signed-off-by: BRIAN GLEESON --- build/publishJavadoc-gha.sh | 4 +++- .../cd_tekton_pipeline/v2/CdTektonPipeline.java | 4 +--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index 4a403b74..97197b1a 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -1,6 +1,6 @@ #!/bin/bash -set -e +# set -e # Required environment variables: # GITHUB_REPO_SLUG @@ -47,6 +47,8 @@ printf "\n>>>>> Generating gh-pages index.html...\n" ../main/build/generateJavadocIndex.sh > index.html printf "\n>>>>> Committing new javadoc...\n" +git config user.email "github-actions[bot]@users.noreply.github.com" +git config user.name "github-actions[bot]" git add -f . printf "\n>>>>> Added files...\n" git commit -m "docs: latest javadoc for ${GITHUB_TAG}" diff --git a/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java b/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java index 4fef0b7b..7fe04a1a 100644 --- a/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java +++ b/modules/cd-tekton-pipeline/src/main/java/com/ibm/cloud/continuous_delivery/cd_tekton_pipeline/v2/CdTektonPipeline.java @@ -79,12 +79,10 @@ import java.util.Map.Entry; /** - * Continuous Delivery Tekton Pipeline API definition <br><br> Maximum request payload size is 512 KB + * Continuous Delivery Tekton pipeline API definition <br><br> Maximum request payload size is 512 KB * <br><br> All calls require an <strong>Authorization</strong> HTTP header. * <br><br> The following header is the accepted authentication mechanism and required credentials for each * <ul><li><b>Bearer:</b> an IBM Cloud IAM token (authorized for all endpoints)</li>. - * - * DEBUGGING TEST * * API Version: 2.0.0 */ From bbdaeeb36c6ca56d24432816b47135ea1646cb79 Mon Sep 17 00:00:00 2001 From: BRIAN GLEESON Date: Mon, 9 Mar 2026 15:05:18 +0000 Subject: [PATCH 14/14] chore: clean up javadoc action Signed-off-by: BRIAN GLEESON --- .github/workflows/publish.yml | 1 + build/publishJavadoc-gha.sh | 21 ++------------------- 2 files changed, 3 insertions(+), 19 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4057d53d..6c5655d6 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -35,6 +35,7 @@ jobs: pages: write steps: + # Checkout the main and gh-pages branches. Main is used to generate the Javadoc, gh-pages stores the output Javadoc. - name: Checkout main branch uses: actions/checkout@v4 with: diff --git a/build/publishJavadoc-gha.sh b/build/publishJavadoc-gha.sh index 97197b1a..46273880 100755 --- a/build/publishJavadoc-gha.sh +++ b/build/publishJavadoc-gha.sh @@ -1,38 +1,21 @@ #!/bin/bash -# set -e +set -e # Required environment variables: # 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" - # 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 +mvn -B -ntp clean javadoc:aggregate --settings build/.github.settings.xml printf "\n>>>>> Finished generating Javadoc...\n" -printf "\n>>>>> [DEBUG] ls -la...\n" -ls -la -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 ../gh-pages/docs/${GITHUB_TAG}