Skip to content

Document required hyperfleet.io/generation annotation#79

Open
rh-amarin wants to merge 1 commit intoopenshift-hyperfleet:mainfrom
rh-amarin:update-doc
Open

Document required hyperfleet.io/generation annotation#79
rh-amarin wants to merge 1 commit intoopenshift-hyperfleet:mainfrom
rh-amarin:update-doc

Conversation

@rh-amarin
Copy link
Contributor

@rh-amarin rh-amarin commented Mar 15, 2026

Summary by CodeRabbit

  • Documentation
    • Updated adapter authoring guidance with new requirements for Kubernetes resource annotations and refreshed examples.

@openshift-ci
Copy link

openshift-ci bot commented Mar 15, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign mischulee for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@coderabbitai
Copy link

coderabbitai bot commented Mar 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 683db997-96f1-4df0-8309-39fb4ad1afdc

📥 Commits

Reviewing files that changed from the base of the PR and between b78bcc5 and 7e6e98c.

📒 Files selected for processing (1)
  • docs/adapter-authoring-guide.md

Walkthrough

This pull request updates the adapter authoring guide documentation by adding guidance on annotating Kubernetes resources with the hyperfleet.io/generation annotation to indicate generation alignment. The existing namespace resource example is updated to include this annotation in the metadata section. No functional changes or logic modifications are introduced.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 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 directly and accurately summarizes the main change—documenting a required annotation in the adapter authoring guide.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant