feat: migrate docs deployment to custom domain

- Replace the uploader-based doc preview pipeline with a new deployment
  pipeline using Cloudflare Pages
- Add post-preview-status step to post the preview URL as a GitHub
  commit status on PRs
- Update all documentation URLs from branch-based subdomains
  to the new custom domain (docs.pipelinesascode.com)
- Update goreleaser release notes URL to use docs.pipelinesascode.com
- Simplify footer version switcher to use path-based routing instead of
  subdomain-based routing
- Remove unused generate-releasenotes.py script

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>

Author: chmouel

.goreleaser.yml

@@ -74,7 +74,7 @@ release:
 
     The documentation for this release is available here :
 
-    https://release-{{ replace .Tag "." "-" }}.pipelines-as-code.pages.dev
+    https://docs.pipelinesascode.com/{{ .Tag }}
 
 homebrew_casks:
   - name: tektoncd-pac

.tekton/doc.yaml

@@ -2,13 +2,16 @@
 apiVersion: tekton.dev/v1beta1
 kind: PipelineRun
 metadata:
-  name: doc-generation
+  name: doc-deployment
   annotations:
     pipelinesascode.tekton.dev/max-keep-runs: "2"
     pipelinesascode.tekton.dev/cancel-in-progress: "true"
-    pipelinesascode.tekton.dev/on-event: "pull_request"
-    pipelinesascode.tekton.dev/on-path-change: "[docs/***]"
-    pipelinesascode.tekton.dev/on-target-branch: "main"
+    pipelinesascode.tekton.dev/on-cel-expression: |
+      event == "push" && (
+        (target_branch == "main" && "docs/***".pathChanged()) ||
+        target_branch.startsWith("refs/tags/")
+      ) ||
+      (event == "pull_request" && "docs/***".pathChanged())
 spec:
   params:
     - name: repo_url
@@ -17,13 +20,16 @@ spec:
       value: "{{revision}}"
     - name: hugo_version
       value: "0.146.0"
+    - name: wrangler_version
+      value: "4.72.0"
   pipelineSpec:
     params:
       - name: repo_url
       - name: revision
       - name: hugo_version
+      - name: wrangler_version
     tasks:
-      - name: build-doc
+      - name: deploy-doc
         taskSpec:
           workspaces:
             - name: source
@@ -56,16 +62,9 @@ spec:
                   value: $(workspaces.source.path)/tmp/hugo
                 - name: workingdir
                   value: $(workspaces.source.path)
-
-            - name: hugo-gen
+            - name: hugo-build
               image: docker.io/golang:1.25
               workingDir: $(workspaces.source.path)
-              env:
-                - name: UPLOADER_PUBLIC_URL
-                  valueFrom:
-                    secretKeyRef:
-                      name: "uploader-upload-credentials"
-                      key: "public_url"
               script: |
                 #!/usr/bin/env bash
                 set -xeuo pipefail
@@ -76,37 +75,56 @@ spec:
                   echo "Hugo was not downloaded properly" && exit 1
                 }
                 cd $(git rev-parse --show-toplevel)/docs
-                url="${UPLOADER_PUBLIC_URL}/docs/{{ pull_request_number }}"
-                ${hugobin} build --gc --minify -d {{ pull_request_number }} -b ${url}
-                echo "Preview URL: ${url}"
-            - name: upload-to-static-server
-              # it has curl and we already pulled it
-              image: docker.io/curlimages/curl
+                ${hugobin} build --gc --minify
+            - name: deploy
+              image: docker.io/node:20-slim
               workingDir: $(workspaces.source.path)
               env:
-                - name: HUB_TOKEN
+                - name: CLOUDFLARE_API_TOKEN
                   valueFrom:
                     secretKeyRef:
-                      name: "nightly-ci-github-hub-token"
-                      key: "hub-token"
-                - name: UPLOADER_UPLOAD_CREDENTIALS
+                      name: cloudflare-creds
+                      key: api-token
+                - name: CLOUDFLARE_ACCOUNT_ID
                   valueFrom:
                     secretKeyRef:
-                      name: "uploader-upload-credentials"
-                      key: "credentials"
-                - name: UPLOADER_PUBLIC_URL
+                      name: cloudflare-creds
+                      key: account-id
+              script: |
+                #!/usr/bin/env bash
+                set -euo pipefail
+                pull_request_number="{{pull_request_number}}"
+                git_tag="{{git_tag}}"
+                target_branch="{{target_branch}}"
+
+                if [[ -n "${pull_request_number}" ]]; then
+                  branch="pr-${pull_request_number}"
+                elif [[ -n "${git_tag}" ]]; then
+                  branch="${git_tag}"
+                else
+                  branch="${target_branch}"
+                fi
+                cd docs/public
+                npx --yes "wrangler@$(params.wrangler_version)" pages deploy . \
+                  --project-name='pipelines-as-code' \
+                  --branch="${branch}"
+            - name: post-preview-status
+              image: docker.io/curlimages/curl
+              env:
+                - name: HUB_TOKEN
                   valueFrom:
                     secretKeyRef:
-                      name: "uploader-upload-credentials"
-                      key: "public_url"
+                      name: "nightly-ci-github-hub-token"
+                      key: "hub-token"
               script: |
-                cd docs
-                test -d "{{ pull_request_number }}" || exit 0
-                tar czf - "{{ pull_request_number }}" | curl -u ${UPLOADER_UPLOAD_CREDENTIALS} -F path=docs -F targz=true -X POST -F file=@- http://uploader:8080/upload
-                # Post as status
+                pull_request_number="{{pull_request_number}}"
+                [[ -z "${pull_request_number}" ]] && exit 0
+                preview_url="https://pr-${pull_request_number}.pipelines-as-code-4ko.pages.dev"
                 set +x
-                curl -H "Authorization: Bearer ${HUB_TOKEN}" -H 'Accept: application/vnd.github.v3+json' -X POST https://api.github.com/repos/{{repo_owner}}/{{repo_name}}/statuses/{{revision}} -d \
-                                                            "{\"state\": \"success\", \"target_url\": \"${UPLOADER_PUBLIC_URL}/docs/{{ pull_request_number }}\", \"description\": \"Generated with brio.\", \"context\": \"Pipelines as Code Preview URL\"}"
+                curl -s -H "Authorization: Bearer ${HUB_TOKEN}" \
+                  -H 'Accept: application/vnd.github.v3+json' \
+                  -X POST "https://api.github.com/repos/{{repo_owner}}/{{repo_name}}/statuses/{{revision}}" \
+                  -d "{\"state\": \"success\", \"target_url\": \"${preview_url}\", \"description\": \"Documentation Preview\", \"context\": \"Pipelines as Code Preview URL\"}"
             - name: cache-upload
               ref:
                 resolver: http
@@ -118,6 +136,8 @@ spec:
                   value: ["$(workspaces.source.path)/README.md"]
                 - name: target
                   value: oci://image-registry.openshift-image-registry.svc:5000/$(context.pipelineRun.namespace)/cache-hugo:v$(params.hugo_version)
+                - name: fetched
+                  value: $(steps.cache-fetch.results.fetched)
                 - name: cachePath
                   value: $(workspaces.source.path)/tmp/hugo
                 - name: workingdir

README.md

@@ -372,7 +372,7 @@ Once you have the `tkn-pac` CLI installed, you can set up your first repository
 
 For more detailed information, please refer to the [official documentation](https://pipelinesascode.com).
 
-The documentation for the development branch is available [here](https://nightly.pipelines-as-code.pages.dev/).
+The documentation for the development branch is available [here](https://docs.pipelinesascode.com/nightly).
 
 ## Contributing
 

docs/content/docs/dev/_index.md

@@ -190,7 +190,7 @@ PAC targets both **arm64** and **amd64** architectures. When contributing:
 ### Staying Updated
 
 - **Releases**: Follow [GitHub releases](https://github.com/tektoncd/pipelines-as-code/releases)
-- **Dev docs**: Check [nightly docs](https://nightly.pipelines-as-code.pages.dev/) for latest changes
+- **Dev docs**: Check [nightly docs](https://docs.pipelinesascode.com/nightly) for latest changes
 
 ## Next Steps
 

docs/layouts/_partials/custom/footer.html

@@ -44,16 +44,12 @@
       function handleVersion(elm) {
         var path = window.location.pathname;
         if (elm.value === "nightly") {
-          window.location =
-            "https://nightly.pipelines-as-code.pages.dev" + path;
+          window.location = "https://docs.pipelinesascode.com/nightly" + path;
         } else if (elm.value === "stable") {
-          window.location = "https://pipelinesascode.com" + path;
+          window.location = "https://docs.pipelinesascode.com/stable" + path;
         } else {
           window.location =
-            "https://release-" +
-            elm.value.replace(/\./g, "-") +
-            ".pipelines-as-code.pages.dev" +
-            path;
+            "https://docs.pipelinesascode.com/" + elm.value + path;
         }
       }
     </script>