NO-JIRA: Test docs deploy preview

[bryan-cox]

Summary

• Minor docs clarification to test the docs deploy preview workflow after merging NO-JIRA: Fix docs deploy preview by replacing gh CLI with curl #8488

Test plan

• Verify Docs Build workflow triggers and succeeds
• Verify Docs Deploy Preview workflow triggers and creates a deployment status
• Verify preview link appears on the PR

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Clarified that Cloudflare Pages preview URLs (pr-.pages.dev) are cleaned up automatically via branch retention policy.
  • Added a Troubleshooting note: if a preview link is missing on a PR, verify the Docs Build workflow succeeded before expecting a Docs Deploy preview.

[openshift-merge-bot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

[openshift-ci-robot]

@bryan-cox: This pull request explicitly references no jira issue.

Details

In response to this:

Summary

• Minor docs clarification to test the docs deploy preview workflow after merging NO-JIRA: Fix docs deploy preview by replacing gh CLI with curl #8488

Test plan

• Verify Docs Build workflow triggers and succeeds
• Verify Docs Deploy Preview workflow triggers and creates a deployment status
• Verify preview link appears on the PR

🤖 Generated with Claude Code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: fad9a914-b422-4594-813a-79b9c5335a31

📥 Commits

Reviewing files that changed from the base of the PR and between d320c67 and b932a2e.

📒 Files selected for processing (1)

• docs/content/how-to/ci/docs-preview.md

✅ Files skipped from review due to trivial changes (1)

• docs/content/how-to/ci/docs-preview.md

---

📝 Walkthrough

Walkthrough

Updated CI docs preview documentation to state that Cloudflare Pages preview deployments (URL format https://pr-<number>.hypershift.pages.dev) are automatically cleaned up by Cloudflare’s branch retention policy. Added a Troubleshooting subsection advising users to confirm the Docs Build workflow completed successfully if a preview link does not appear on a pull request.

Suggested reviewers

• sdminonne
• sjenning

---

Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error, 1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Stable And Deterministic Test Names	❌ Error	11 Ginkgo test names use fmt.Sprintf with workload.Name variables, making test names dynamic and non-deterministic. Found in test/e2e/v2/tests/control_plane_*.go files.	Replace fmt.Sprintf test names with static descriptive strings. Move workload.Name to test body assertions instead of test titles.
Ipv6 And Disconnected Network Test Compatibility	⚠️ Warning	Multiple new Ginkgo e2e tests contain IPv4-only assumptions that will fail in IPv6-only disconnected environments. Hardcoded IPv4 CIDRs and IPv4-specific string parsing found.	Tests contain hardcoded IPv4 addresses "0.0.0.0/32", "0.0.0.0/0", "250.250.250.X/32" and IPv4-specific parsing with strings.HasPrefix(ip, "10."). Use GetIPAddressFamily() to detect cluster IP family and adapt accordingly.
Title check	❓ Inconclusive	The title "NO-JIRA: Test docs deploy preview" is vague and does not clearly describe the specific changes made. It states a test intent rather than summarizing the actual documentation changes added to the file.	Replace with a more specific title that describes the actual change, such as "docs: Add troubleshooting section to docs preview page" or "docs: Clarify Cloudflare Pages preview cleanup and troubleshooting"

✅ Passed checks (9 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Test Structure And Quality	✅ Passed	This PR only modifies documentation (docs-preview.md) with no Ginkgo test code. The custom check for test code review does not apply to documentation-only changes.
Microshift Test Compatibility	✅ Passed	PR only modifies documentation (docs-preview.md). No Ginkgo e2e tests are added or modified. The MicroShift test compatibility check applies only when new tests are added, which is not the case here.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	The check targets new Ginkgo e2e tests. This PR only modifies documentation, with no Ginkgo tests added. Check is not applicable.
Topology-Aware Scheduling Compatibility	✅ Passed	Documentation-only change. No manifests, operators, or scheduling constraints introduced.
Ote Binary Stdout Contract	✅ Passed	PR only modifies documentation (docs/content/how-to/ci/docs-preview.md). The OTE Binary Stdout Contract check applies only to executable code and test entry points, which were not modified in this PR.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bryan-cox

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [bryan-cox]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[hypershift-jira-solve-ci]

I have all the evidence I need. Here is the complete analysis:

Test Failure Analysis Complete

Job Information

• Prow Job: verify / Verify (GitHub Actions reusable workflow verify-reusable.yaml)
• Build ID: 25739688605 / Job 75586269802
• PR: NO-JIRA: Test docs deploy preview #8492 — NO-JIRA: Test docs deploy preview
• Branch: test-docs-preview
• Commit: b932a2e014e2bdd2ab9eb9761b752285b1a27a93

Test Failure Analysis

Error

docs/content/reference/aggregated-docs.md: needs update
##[error]Process completed with exit code 1.

Summary

The verify job runs make verify which, among other targets, executes the docs-aggregator tool (go run ./hack/tools/docs-aggregator/main.go). This tool walks all markdown files under docs/content/ and concatenates them into a single file at docs/content/reference/aggregated-docs.md. The PR modified docs/content/how-to/ci/docs-preview.md (adding a cleanup note and a troubleshooting section), but did not regenerate aggregated-docs.md to reflect those changes. The final git-dirty-tree check (git diff --exit-code HEAD --) detected the stale file and failed the build.

Root Cause

The repository has a docs-aggregator tool (hack/tools/docs-aggregator/main.go) that scans every markdown file under docs/content/, strips markdown links/images, and writes a combined file to docs/content/reference/aggregated-docs.md (used for AI tools like NotebookLM).

The PR changed docs/content/how-to/ci/docs-preview.md — adding a sentence about Cloudflare branch retention and a new "Troubleshooting" section — but the author did not run make verify (or specifically make aggregated-docs) locally before pushing. During CI, the aggregator re-generated aggregated-docs.md with the new content (line 982: "Successfully aggregated 284 documentation files"), which then differed from the committed version. The git-dirty-tree check at the end of the verify workflow detected this uncommitted change and failed:

docs/content/reference/aggregated-docs.md: needs update

This is not a product bug or infrastructure issue — it is simply a missing generated-file update in the PR.

Recommendations

1. Regenerate the aggregated docs file — Run make verify or make aggregated-docs locally, then commit the updated docs/content/reference/aggregated-docs.md:

   make aggregated-docs
   git add docs/content/reference/aggregated-docs.md
   git commit --amend  # or a new commit

2. General practice — Any PR that touches files under docs/content/ must also regenerate the aggregated docs. Running make verify locally before pushing will catch this.

Evidence

Evidence	Detail
Failing step	git diff --exit-code HEAD -- in the git-dirty-tree check
Dirty file	docs/content/reference/aggregated-docs.md: needs update (log line 1025)
Generator run	go run ./hack/tools/docs-aggregator/main.go → "Successfully aggregated 284 documentation files to docs/content/reference/aggregated-docs.md" (log line 981–982)
PR changed file	docs/content/how-to/ci/docs-preview.md — added Cloudflare cleanup note + Troubleshooting section
Aggregator source	hack/tools/docs-aggregator/main.go — walks all docs/content/**/*.md, concatenates into aggregated-docs.md
Workflow file	.github/workflows/verify-reusable.yaml — runs make verify then checks git diff --exit-code HEAD

---