Skip to content

Add APM instructions for config directory#3555

Merged
openshift-merge-bot[bot] merged 3 commits into
openshift:mainfrom
stbenjam:help-claude-understand
May 25, 2026
Merged

Add APM instructions for config directory#3555
openshift-merge-bot[bot] merged 3 commits into
openshift:mainfrom
stbenjam:help-claude-understand

Conversation

@stbenjam
Copy link
Copy Markdown
Member

@stbenjam stbenjam commented May 25, 2026

Summary

  • Adds .apm/instructions/config.instructions.md documenting how the config files work:
    • openshift.yaml is generated by sippy-config-generator — do not edit manually
    • openshift-customizations.yaml is the manually maintained overlay for pseudoreleases and exclusions
    • Views files are for Component Readiness
  • Includes a reference link to docs.ci explaining how jobs end up in Sippy

Motivated by #3554 (comment)

Test plan

  • make apm succeeds and generated files are up to date

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added detailed documentation describing the configuration directory, how CI jobs are tracked, the distinction between generated vs. manually maintained config, and customization options for pseudoreleases, job inclusion/exclusion, and component readiness overrides.
  • Chores

    • Updated configuration metadata to record additional locally deployed rule files and their hashes.

stbenjam and others added 2 commits May 25, 2026 08:23
Document how Sippy configuration files work: openshift.yaml is
generated by sippy-config-generator and should not be edited manually,
openshift-customizations.yaml is the overlay for pseudoreleases and
manual additions, and the views files are for Component Readiness.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-merge-bot
Copy link
Copy Markdown
Contributor

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: automatic mode

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 25, 2026

Walkthrough

This PR introduces documentation and APM infrastructure for the Sippy configuration directory. It adds an instruction file explaining how configuration files are structured and used, registers deployed rule files in the APM lock, and generates corresponding project documentation describing the config directory's role in tracking CI jobs per release.

Changes

Configuration Documentation and Infrastructure Updates

Layer / File(s) Summary
APM instruction file and deployment lock
.apm/instructions/config.instructions.md, apm.lock.yaml
New instruction markdown documents configuration directory structure, generated vs. manually maintained files, and customization overlays. APM lock file updated with two new locally deployed rule files (.claude/rules/config.md, .cursor/rules/config.mdc) and corresponding SHA256 hashes.
Generated configuration directory documentation
config/AGENTS.md, config/CLAUDE.md
APM-generated documentation files describing the config directory's purpose, which files are auto-generated and which are manually maintained, supported customization behaviors, and regeneration instructions via APM CLI.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes


Caution

Pre-merge checks failed

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

  • Ignore

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Sql Injection Prevention ❌ Error SQL injection vulnerability in pkg/db/query/build_clusters.go: BuildClusterAnalysis uses fmt.Sprintf to concatenate user-controlled period parameter directly into SQL query. Replace fmt.Sprintf with parameterized query using sql.Named to safely pass the period parameter instead of string concatenation.
✅ Passed checks (16 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly and clearly summarizes the main change: adding APM instructions documentation for the config directory.
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.
Go Error Handling ✅ Passed PR contains no Go code changes—only documentation and configuration files (.md, .mdc, .yaml). Go error handling check not applicable.
Excessive Css In React Should Use Styles ✅ Passed PR only modifies documentation and configuration files (.md and .yaml). No React components or JSX code present, so the useStyles CSS check is not applicable.
Test Coverage For New Features ✅ Passed All changes are documentation and configuration files with no new Go functions, bug fixes, or frontend logic—explicit exceptions per the custom check.
Single Responsibility And Clear Naming ✅ Passed PR contains only documentation and configuration files (YAML, Markdown). The custom check evaluates code architecture (packages, structs, methods) which is not applicable to this PR.
Stable And Deterministic Test Names ✅ Passed PR contains only documentation and configuration files; no Ginkgo test files present, so the check is not applicable.
Test Structure And Quality ✅ Passed PR contains only documentation and configuration files (.md and .yaml), with no Ginkgo test code. Check is not applicable.
Microshift Test Compatibility ✅ Passed This repository uses standard Go testing, not Ginkgo. No Ginkgo e2e tests are added in this PR, making the MicroShift test compatibility check inapplicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed This PR adds only documentation and configuration files; no Ginkgo e2e tests are added. The SNO test compatibility check is not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed PR contains only documentation files (.apm/instructions, config/*.md, apm.lock.yaml) and configuration metadata; no deployment manifests, operator code, or scheduling constraints are introduced.
Ote Binary Stdout Contract ✅ Passed The OTE Binary Stdout Contract check is not applicable to this PR. Sippy is a Prow job analysis tool, not an OTE binary for test listing.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed This PR adds only documentation files (.apm/instructions/config.instructions.md, config/AGENTS.md, config/CLAUDE.md), not Ginkgo e2e tests. The check is not applicable.
✨ 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 openshift-ci Bot requested review from dgoodwin and smg247 May 25, 2026 12:25
@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 25, 2026
Adding a new release to openshift-customizations.yaml requires
registering it in the central database and filing a TRT Jira ticket.
Also removes duplicate docs.ci reference link.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci openshift-ci Bot added the ready-for-human-review Indicates a PR has been reviewed by automated tools and is ready for human review label May 25, 2026
@openshift-merge-bot
Copy link
Copy Markdown
Contributor

Scheduling required tests:
/test e2e

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 25, 2026

@stbenjam: all tests passed!

Full PR test history. Your PR dashboard.

Details

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 kubernetes-sigs/prow repository. I understand the commands that are listed here.

@neisw
Copy link
Copy Markdown
Contributor

neisw commented May 25, 2026

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label May 25, 2026
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 25, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: neisw, stbenjam

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:

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

@openshift-merge-bot openshift-merge-bot Bot merged commit a6ee313 into openshift:main May 25, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. ready-for-human-review Indicates a PR has been reviewed by automated tools and is ready for human review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants