Skip to content

🌱 AGENTS.md: experimental API compatibility policy - #3035

Merged
openshift-merge-bot[bot] merged 1 commit into
operator-framework:mainfrom
fgiudici:agents-experimental-api-guidance
Oct 20, 2026
Merged

openshift-merge-bot[bot] merged 1 commit into
operator-framework:mainfrom
fgiudici:agents-experimental-api-guidance

Conversation

@fgiudici

@fgiudici fgiudici commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

Clarify that experimental APIs may change incompatibly without migration support.

Description

Update AGENTS.md to avoid agents adding plans and code to support migration for experimental API changes.

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

Summary by CodeRabbit

  • Documentation
    • Clarified that experimental APIs may change incompatibly without migration support.
    • Added guidance requiring experimental API changes to follow documented API conventions and regeneration requirements.
    • Confirmed that compatibility guarantees for stable APIs and supported production migration fixes remain in effect.

Clarify that experimental APIs may change incompatibly without
migration support.

Signed-off-by: Francesco Giudici <fgiudici@redhat.com>
@openshift-ci
openshift-ci Bot requested review from dtfranz and pedjak October 20, 2026 09:49
@netlify

netlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 438d27b
🔍 Latest deploy log https://app.netlify.com/projects/olmv1/deploys/6ad739314ed55b5902a9e2b2
😎 Deploy Preview https://deploy-preview-3035--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a5809b44-bc88-4cdf-a9ee-e1497a03f103
📥 Commits

Reviewing files that changed from the base of the PR and between 09a7363 and 438d27b.

📒 Files selected for processing: 1
  • AGENTS.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

📝 Walkthrough

The Feature Gates guidance now states that experimental API changes may be incompatible and receive no migration support. It also requires these changes to follow API conventions and regeneration requirements.

Changes: Experimental API policy

Layer / File(s) Summary
Feature Gates guidance
AGENTS.md
The guidance distinguishes experimental API compatibility and migration support from stable API guarantees. It also specifies API convention and regeneration requirements for experimental changes.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 438d2

This documentation-only change introduces no actionable merge risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Description check Passed The description explains the change and its motivation. It includes the required Description and Reviewer Checklist sections. Checklist items remain unchecked, but this is acceptable for a mostly comp…
Title check Passed The title is concise, specific, and accurately describes the update to the experimental API compatibility policy in AGENTS.md.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Description check

Explanation

The description explains the change and its motivation. It includes the required Description and Reviewer Checklist sections. Checklist items remain unchecked, but this is acceptable for a mostly complete description.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Oct 20, 2026
@openshift-ci

openshift-ci Bot commented Oct 20, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: perdasilva

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-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 20, 2026
@openshift-merge-bot
openshift-merge-bot Bot merged commit b8b2894 into operator-framework:main Oct 20, 2026
35 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants