HYPERFLEET-488 - test: Add hyperfleet e2e CI job doc

[yingzhanredhat]

Summary by CodeRabbit

• Documentation
  • Added a comprehensive guide for adding and managing Hyperfleet E2E CI jobs in Prow, including job setup, step registry and parameter guidance, command/script examples, ownership/metadata, and YAML definitions.
  • Documented job monitoring and URLs, manual and PR-based triggering, creating additional jobs, debugging and log/artifact access, CI PR examples, and references.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds a new documentation file that describes how to add and manage Hyperfleet E2E CI jobs in Prow. Covers job configuration initialization, step-registry content and YAML step definitions, step parameters and command scripts, ownership/metadata and credential handling, locating and monitoring running jobs, manual triggering methods (Prow dashboard and PR-based), creating additional jobs, debugging (logs/artifacts), CI PR examples, and references to related docs and repositories.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• HYPERFLEET-483 - ci: Add the CD job setup doc #78: Adds/updates Prow job documentation and conventions for Hyperfleet, overlapping on step-registry layout and job configuration.

Suggested reviewers

• xueli181114
• yasun1

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding documentation for hyperfleet e2e CI job configuration in Prow.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In `@hyperfleet/test-release/add-hyperfleet-e2e-ci-job-in-prow.md`:
- Around line 4-6: Replace bolded label lines (e.g., "**Metadata**") with proper
Markdown headings (e.g., "## Metadata") throughout the document to satisfy
markdownlint and improve structure/TOC; update the occurrences at the initial
block and the other locations referenced (lines 35-36, 62-63, 73-74) so each
section uses an appropriate heading level (#, ##, or ###) instead of emphasized
text and ensure any following content remains on subsequent lines.
- Line 1: The document title contains a typo "n-prow" — update the heading
string in the file (the top-line markdown heading) from "# Add Hyperfleet E2E CI
Job n-prow" to "# Add Hyperfleet E2E CI Job in Prow" so it reads correctly with
capitalized "Prow".
- Line 95: Replace the bare URL in the line "Navigate to the Prow dashboard:
https://prow.ci.openshift.org/" with a Markdown link (e.g., "Navigate to the
Prow dashboard: [https://prow.ci.openshift.org](https://prow.ci.openshift.org)"
or "Navigate to the Prow dashboard: [Prow
dashboard](https://prow.ci.openshift.org/)") so the document uses a proper
markdown link and satisfies MD034; update that specific sentence in the file.

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In `@hyperfleet/test-release/add-hyperfleet-e2e-ci-job-in-prow.md`:
- Around line 158-159: Update the mismatched PR link text and URLs in the two
bullet lines: ensure the visible link text "[PR `#73258`]" and "[PR `#73661`]" match
their actual target URLs "https://github.com/openshift/release/pull/73127" and
"https://github.com/openshift/release/pull/73973" respectively by correcting
either the bracketed PR numbers or the URLs so both sides reference the same PR
numbers; locate the lines containing the exact link texts and URLs and make the
numbers consistent.
- Line 78: The metadata.json example contains an inconsistent "path" value
("openshift-hyperfleet/chart-deployment/openshift-hyperfleet-e2e-ref.yaml")
versus the documented location for step files (the e2e folder); update the
"path" string in the metadata.json example to point to the e2e folder (e.g.,
change the value to
"openshift-hyperfleet/e2e/openshift-hyperfleet-e2e-ref.yaml") so the example
matches the stated location.
- Around line 68-69: Add an explicit HYPERFLEET_E2E_PATH entry to the YAML env
section so the referenced variable in the comment and GCP_CREDENTIALS_FILE
assignment is defined; update the YAML example's env block to include a key
named HYPERFLEET_E2E_PATH with a sensible default (e.g.,
/var/run/hyperfleet-e2e) and brief documentation indicating it is the mount path
for hyperfleet-e2e credentials, ensuring consistency with the credentials
mount_path and the
GCP_CREDENTIALS_FILE="${HYPERFLEET_E2E_PATH}/hcm-hyperfleet-e2e.json" usage.