Add OSSM general information about all the jobs used by the team#81380
Conversation
Signed-off-by: Francisco Herrera <fjglira@gmail.com>
Signed-off-by: Francisco Herrera <fjglira@gmail.com>
WalkthroughThis PR rewrites the Sail Operator CI README, adding a CI jobs overview with repo/job tables, instructions for manually triggering presubmit jobs, a Slack notification channel mapping, an updated performance job trigger example, and simplified test results/metrics documentation. ChangesSail Operator CI README Update
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (14 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/retest |
|
[REHEARSALNOTIFIER] Note: If this PR includes changes to step registry files ( |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@ci-operator/config/openshift-service-mesh/sail-operator/README.md`:
- Around line 69-71: The fenced /test example in the README is missing a
language tag, which triggers markdownlint MD040. Update the fenced block around
the /test <variant>-<job> example to use an explicit language such as bash or
text so the README stays lint-clean.
🪄 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: 11fa54e1-95c8-43df-a87f-d7dc3ed60e4b
📒 Files selected for processing (1)
ci-operator/config/openshift-service-mesh/sail-operator/README.md
| ``` | ||
| /test <variant>-<job> | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a language to the /test example fence.
The bare fenced block trips markdownlint (MD040). Mark it as bash or text so the README stays lint-clean.
Proposed fix
-```
+```bash
/test <variant>-<job>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` | |
| /test <variant>-<job> | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 69-69: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@ci-operator/config/openshift-service-mesh/sail-operator/README.md` around
lines 69 - 71, The fenced /test example in the README is missing a language tag,
which triggers markdownlint MD040. Update the fenced block around the /test
<variant>-<job> example to use an explicit language such as bash or text so the
README stays lint-clean.
Source: Linters/SAST tools
|
/retest |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fjglira, MaxBab The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@fjglira: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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 kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Instead of having a specific readme inside each folder I'm gathering all the information in only one place for simplicity. Also simplifiying a lot the current sail read me to keep it simple for users to read
Summary by CodeRabbit
This PR centralizes OSSM CI job documentation into a single Sail Operator README, making it easier to find and understand the team’s job workflows across federation, istio, proxy, sail-operator, and ztunnel. It also adds practical guidance for manually triggering presubmit and postsubmit jobs, including the relevant
/testcommand patterns and Slack notification channels.For Sail Operator performance testing, the documentation has been simplified and updated to reflect the current workflow. The PR refreshes the performance job trigger example, trims the results/access instructions down to the most useful locations, and streamlines the listed metrics so the README is shorter and easier to follow.