GCP-298: Add GCP e2e v2 test artifacts directory structure documentation#8446
GCP-298: Add GCP e2e v2 test artifacts directory structure documentation#8446cristianoveiga wants to merge 1 commit intoopenshift:mainfrom
Conversation
|
Pipeline controller notification For optional jobs, comment This repository is configured in: LGTM mode |
|
Skipping CI for Draft Pull Request. |
openshift-ci
Bot
added
the
do-not-merge/work-in-progress
openshift-ci-robot
added
the
jira/valid-reference
|
@cristianoveiga: This pull request references GCP-298 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
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. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis pull request adds two new documentation pages and updates site navigation. It introduces a GCP E2E Test Debugging Guide (v2 Framework) covering general debugging strategy, step-by-step failure scenarios, and GCP-specific troubleshooting (PSC, DNS, WIF/OIDC, CAPG), plus notes on SHARED_DIR, secrets, K8sGPT results, and orphaned project cleanup. It also adds a GCP E2E Test Artifacts Navigation Guide detailing artifact locations, directory structure, per-run organization, and debugging workflows. The mkdocs configuration was updated to include a "GCP / GKE e2e (v2)" nav subtree. 🚥 Pre-merge checks | ✅ 12✅ Passed checks (12 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: cristianoveiga The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
openshift-ci
Bot
added
area/documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (5)
docs/content/reference/test-information-debugging/GCP/ci-infrastructure.md (2)
110-114: ⚡ Quick winAdd language specification to Go code example.
The Go test code example should be marked with the
golanguage identifier to enable syntax highlighting, making it easier for developers to read and understand the test structure.📝 Proposed fix
- ``` + ```go g.It("should do something on GCP", Label("platform:gcp"), func(ctx context.Context) { // test implementation })🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/reference/test-information-debugging/GCP/ci-infrastructure.md` around lines 110 - 114, The code fence for the Go test example is missing the language identifier; update the markdown code block that contains g.It("should do something on GCP", Label("platform:gcp"), func(ctx context.Context) { ... }) to use a Go language fence by changing the opening triple backticks to "```go" so the snippet (containing g.It, Label, and func(ctx context.Context)) renders with Go syntax highlighting.
79-81: 💤 Low valueConsider adding language specification to command examples.
The Prow command examples would benefit from language specification for consistent rendering. While these are simple commands, marking them as
textorbashensures they render consistently across different Markdown processors.📝 Proposed fix
-``` +```text /test e2e-v2-gkeTrigger a Rehearsal
For testing step registry changes in
openshift/release:-
+text
/pj-rehearse pull-ci-openshift-hypershift-main-e2e-v2-gkeAlso applies to: 87-89
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/reference/test-information-debugging/GCP/ci-infrastructure.md` around lines 79 - 81, Update the Markdown code fences around the Prow command examples so they include a language identifier (e.g., change the triple backticks from ``` to ```text) for the snippets shown in the commands such as "/test e2e-v2-gke" and "/pj-rehearse pull-ci-openshift-hypershift-main-e2e-v2-gke" (also apply the same change to the other example block referenced at lines 87-89) to ensure consistent rendering across processors.docs/content/reference/test-information-debugging/GCP/debugging-guide.md (2)
272-288: ⚡ Quick winAdd language specification to bash command code blocks for cleanup commands.
The orphaned project cleanup commands should be marked with the
bashlanguage identifier for better syntax highlighting and user experience.📝 Proposed fix
-``` +```bash gcloud projects list --filter="parent.id=614095012709" --format="table(projectId,createTime)"Cleanup options:
- Automated: Use the
gcp-orphan-cleanupClaude Code skill to identify and clean up orphaned resources- Manual cleanup:
</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/content/reference/test-information-debugging/GCP/debugging-guide.md
around lines 272 - 288, The markdown code blocks for the cleanup commands lack a
language hint; update the two manual cleanup code fences that surround the
gcloud commands (the block containing "gcloud projects delete " and
the block with "gcloud dns record-sets list ") to include the bash language
identifier (i.e., change the opening triple backticks to ```bash) so the
examples (gcloud projects delete, gcloud dns record-sets list, and the earlier
gcloud projects list command) render with proper shell syntax highlighting.</details> --- `156-169`: _⚡ Quick win_ **Add language specification to bash command code blocks.** The bash command examples for DNS record management should be marked with the `bash` language identifier to enable syntax highlighting and improve readability. <details> <summary>📝 Proposed fix</summary> ```diff - ``` + ```bash gcloud dns record-sets list \ --zone=hypershift-ci-gcp-hcp-openshiftapps-com \ --project=gcp-hcp-hypershift-ci \ --filter="name~<cluster-name>" ``` 3. To clean up orphaned DNS records: - ``` + ```bash gcloud dns record-sets delete <record-name> \ --zone=hypershift-ci-gcp-hcp-openshiftapps-com \ --project=gcp-hcp-hypershift-ci \ --type=A ``` ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/content/reference/test-information-debugging/GCP/debugging-guide.md
around lines 156 - 169, Update the two Markdown code fences containing the
gcloud commands so they include the bash language identifier (i.e., change the
opening triple-backtick lines for the gcloud dns record-sets list and gcloud dns
record-sets delete blocks to ```bash) to enable syntax highlighting; ensure only
the opening fence is changed for each block and the rest of the command content
(the backslashes and flags) remains unchanged.</details> </blockquote></details> <details> <summary>docs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.md (1)</summary><blockquote> `121-220`: _💤 Low value_ **Consider adding language specification to the directory tree code block.** The fenced code block containing the directory tree structure would render more consistently with an explicit language specification. While the current rendering may work, adding `text` ensures consistent formatting across different Markdown renderers. <details> <summary>📝 Proposed fix</summary> ```diff -``` +```text <run-id>/ ├── build-log.txt ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.md
around lines 121 - 220, Update the fenced code block that renders the directory
tree so it includes an explicit language specifier by changing the opening fence
to ```text; locate the fenced block that begins with "/" in the file
docs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.md
and modify its opening fence only (the block containing the directory tree
listing) to use "text" for consistent Markdown rendering.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.Nitpick comments:
In@docs/content/reference/test-information-debugging/GCP/ci-infrastructure.md:
- Around line 110-114: The code fence for the Go test example is missing the
language identifier; update the markdown code block that contains g.It("should
do something on GCP", Label("platform:gcp"), func(ctx context.Context) { ... })
to use a Go language fence by changing the opening triple backticks to "```go"
so the snippet (containing g.It, Label, and func(ctx context.Context)) renders
with Go syntax highlighting.- Around line 79-81: Update the Markdown code fences around the Prow command
examples so they include a language identifier (e.g., change the triple
backticks fromtotext) for the snippets shown in the commands such as
"/test e2e-v2-gke" and "/pj-rehearse
pull-ci-openshift-hypershift-main-e2e-v2-gke" (also apply the same change to the
other example block referenced at lines 87-89) to ensure consistent rendering
across processors.In
@docs/content/reference/test-information-debugging/GCP/debugging-guide.md:
- Around line 272-288: The markdown code blocks for the cleanup commands lack a
language hint; update the two manual cleanup code fences that surround the
gcloud commands (the block containing "gcloud projects delete " and
the block with "gcloud dns record-sets list ") to include the bash language
identifier (i.e., change the opening triple backticks to ```bash) so the
examples (gcloud projects delete, gcloud dns record-sets list, and the earlier
gcloud projects list command) render with proper shell syntax highlighting.- Around line 156-169: Update the two Markdown code fences containing the gcloud
commands so they include the bash language identifier (i.e., change the opening
triple-backtick lines for the gcloud dns record-sets list and gcloud dns
record-sets delete blocks to ```bash) to enable syntax highlighting; ensure only
the opening fence is changed for each block and the rest of the command content
(the backslashes and flags) remains unchanged.In
@docs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.md:
- Around line 121-220: Update the fenced code block that renders the directory
tree so it includes an explicit language specifier by changing the opening fence
to ```text; locate the fenced block that begins with "/" in the file
docs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.md
and modify its opening fence only (the block containing the directory tree
listing) to use "text" for consistent Markdown rendering.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Repository YAML (base), Central YAML (inherited) **Review profile**: CHILL **Plan**: Enterprise **Run ID**: `c02a401b-299f-4a0a-a2ad-c79f184becf0` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 5a83831d8f89367738f778aeb25e65253412b933 and 9b19a27344c401a58e40402af56acc938326ba96. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `docs/content/reference/test-information-debugging/GCP/ci-infrastructure.md` * `docs/content/reference/test-information-debugging/GCP/debugging-guide.md` * `docs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.md` * `docs/mkdocs.yml` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
cristianoveiga
force-pushed
the
docs/gcp-v2-test-artifacts-documentation
branch
2 times, most recently
from
ec6281b to
23f0ff5
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/reference/test-information-debugging/GCP/ci-infrastructure.md`:
- Line 79: Add the missing language identifier "text" to the three unlabeled
fenced code blocks that currently start with the lines "/test e2e-v2-gke",
"/pj-rehearse pull-ci-openshift-hypershift-main-e2e-v2-gke", and the block
beginning with "api/hypershift/v1beta1/gcp.*" so they read as ```text fenced
blocks; update the fences at the occurrences referenced (the blocks containing
those exact strings) to use ```text instead of ``` to satisfy MD040 linting.
In `@docs/content/reference/test-information-debugging/GCP/debugging-guide.md`:
- Line 75: Unlabeled fenced code blocks in debugging-guide.md (examples: the
status selector ".status.version.history[0].state" and path
"dump/artifacts/namespaces/clusters/hypershift.openshift.io/hostedclusters/*.yaml")
are triggering MD040; update each fence to include the appropriate language tag
(use "yaml" for status/manifest snippets like .status.version.history[0].state
and "text" for file/path examples like
dump/artifacts/.../hostedclusters/*.yaml), and apply the same labeling to the
other unlabeled fences referenced in the comment so all code blocks include a
language tag.
In
`@docs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.md`:
- Line 121: Update the unlabeled fenced code block that contains the artifact
tree (the block starting with "<run-id>/" and listing build-log.txt) by adding a
language hint "text" to the opening fence (i.e., change the opening ``` to
```text) so the block is labeled and MD040 lint errors are avoided; locate the
fenced block in test-artifacts-directory-structure.md around the artifact tree
and modify only the opening fence marker.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: eedea1e8-80b5-49ee-8f7e-2289b48be6b6
📒 Files selected for processing (4)
docs/content/reference/test-information-debugging/GCP/ci-infrastructure.mddocs/content/reference/test-information-debugging/GCP/debugging-guide.mddocs/content/reference/test-information-debugging/GCP/test-artifacts-directory-structure.mddocs/mkdocs.yml
cristianoveiga
force-pushed
the
docs/gcp-v2-test-artifacts-documentation
branch
7 times, most recently
from
c80adfd to
7e7fd8e
Compare
cristianoveiga
changed the title
cristianoveiga
force-pushed
the
docs/gcp-v2-test-artifacts-documentation
branch
from
7e7fd8e to
0125282
Compare
Add test-artifacts-directory-structure.md for the e2e-v2-gke CI workflow under docs/content/reference/test-information-debugging/GCP/. The document covers the full v2 artifact tree (13 steps), quick navigation index, K8sGPT results locations, and debugging workflows based on real artifact paths from actual CI runs. Also updates mkdocs.yml to add the new page under Test Information/Debugging. The v1 e2e-gke workflow is excluded as it is being decommissioned. Signed-off-by: Cristiano Veiga <cveiga@redhat.com> Commit-Message-Assisted-by: Claude (via Claude Code)
cristianoveiga
force-pushed
the
docs/gcp-v2-test-artifacts-documentation
branch
from
0125282 to
b1db9bb
Compare
2 participants
Summary
Add
test-artifacts-directory-structure.mdfor thee2e-v2-gkeCI workflow, following the same structure as the existing ARO HCP / AKS e2e documentation.The document covers:
Artifact paths were validated against a real successful run.
The v1
e2e-gkeworkflow is excluded — it is being decommissioned in favour of the v2 framework.Test plan
e2e-v2-gkerun🤖 Generated with Claude Code