fix: enhance workflows for OCM CLI documentation updates and HTML verification (#463)

On-behalf-of: Gerald Morrison (SAP) <[email protected]>
Signed-off-by: Gerald Morrison (SAP) <[email protected]>

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it
fixes: open-component-model/ocm-project#492

---------

Signed-off-by: Gerald Morrison (SAP) <[email protected]>
Co-authored-by: Gerald Morrison (SAP) <[email protected]>

Author: morri-son

.github/workflows/update-cli-docs.yaml

@@ -1,5 +1,10 @@
 name: Update OCM CLI Docs
 
+permissions:
+  contents: read          # for checkout, file reads
+  actions: write          # to call repository_dispatch
+  pull-requests: write    # to create or update PRs
+
 on:
   repository_dispatch:
     types: [ocm-cli-release]
@@ -20,22 +25,36 @@ jobs:
     - uses: actions/checkout@v4
       with:
         persist-credentials: false
+
     - name: Update Version Parameter
       run: |
         TAG=${{ github.event.client_payload.tag }}
         sed -i "s/latest_version = .*/latest_version = \"$TAG\"/" ./config/_default/params.toml
+
     - name: Setup Go
       uses: actions/setup-go@v5
       with:
         go-version-file: '${{ github.workspace }}/go.mod'
+
     - name: Regenerate CLI docs
       run: |
         go get ocm.software/ocm@${{ github.event.client_payload.tag }}
         go mod tidy
         go run ./hack/generate-cli-docs --output-dir=${{ env.OUTPUT_DIR }}
+
+    - name: Get OCMBot installation token
+      # Instead of creating the PR below with GITHUB_TOKEN use a generated
+      # short-lived App installation token with full REST rights
+      id: generate_token
+      uses: tibdex/github-app-token@v2
+      with:
+        app_id: ${{ secrets.OCMBOT_APP_ID }}
+        private_key: ${{ secrets.OCMBOT_PRIV_KEY }}
+
     - name: Create Pull Request
       uses: peter-evans/create-pull-request@v7
       with:
+        token: ${{ steps.generate_token.outputs.token }}
         title: "Update CLI docs"
         commit-message: "[github-actions] automated change"
         add-paths: |
@@ -49,3 +68,4 @@ jobs:
         sign-commits: true
         body: |
           Update OCM CLI documentation for new release
+  

.github/workflows/verify-html.yml

@@ -22,4 +22,4 @@ jobs:
       - name: Verify HTML links
         uses: untitaker/[email protected]
         with:
-          args: public/ --sources content/
+          args: public/ --sources content/