Skill to author adapter configurations#4
Skill to author adapter configurations#4rh-amarin wants to merge 1 commit intoopenshift-hyperfleet:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
WalkthroughThis pull request adds documentation and configuration infrastructure for a HyperFleet adapter authoring skill. It includes updates to the OWNERS file with approvers and reviewers lists, a new README describing the adapter-config-author interactive skill for guiding users through YAML configuration authoring, and comprehensive SKILL.md documentation covering configuration schemas, templates for various cluster types, reference materials, testing workflows, and verification procedures. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
hyperfleet-adapter-authoring/skills/references/authoring-guide.md (1)
23-28: Clarify the Kind column for broker.yaml.The table shows an empty Kind field for
broker.yaml. If the broker configuration doesn't use a Kubernetes-styleKindfield, consider adding a note or using "N/A" to make this explicit. Alternatively, if there is a kind field, it should be documented here.📝 Suggested clarification
| File | Kind | Purpose | |------|------|---------| | `adapter-config.yaml` | `AdapterConfig` | Deployment settings: API client config, broker subscription, timeouts, retries | | `adapter-task-config.yaml` | `AdapterTaskConfig` | Business logic: what to extract, check, create, and report | -| `broker.yaml` | `` | Broker configuration: Configures broker system (pubsub, rabbitmq) | +| `broker.yaml` | (no Kind field) | Broker configuration: Configures broker system (pubsub, rabbitmq) |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@hyperfleet-adapter-authoring/skills/references/authoring-guide.md` around lines 23 - 28, Update the table row for broker.yaml so the Kind column is explicit: either set it to "N/A" if broker.yaml does not use a Kubernetes-style Kind, or fill in the actual Kind value if it exists; additionally add a brief parenthetical note in the Purpose cell or as a footnote clarifying whether broker.yaml uses a Kind field (e.g., "Kind: N/A — not Kubernetes manifest") to remove ambiguity for readers; target the table row containing `broker.yaml` and the `Kind` column.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@hyperfleet-adapter-authoring/README.md`:
- Line 49: The README references the wrong relative path string
'references/authoring-guide.md'; update that occurrence in
hyperfleet-adapter-authoring/README.md to 'skills/references/authoring-guide.md'
so the link resolves correctly (locate the line containing the literal
'references/authoring-guide.md' and replace it with
'skills/references/authoring-guide.md').
---
Nitpick comments:
In `@hyperfleet-adapter-authoring/skills/references/authoring-guide.md`:
- Around line 23-28: Update the table row for broker.yaml so the Kind column is
explicit: either set it to "N/A" if broker.yaml does not use a Kubernetes-style
Kind, or fill in the actual Kind value if it exists; additionally add a brief
parenthetical note in the Purpose cell or as a footnote clarifying whether
broker.yaml uses a Kind field (e.g., "Kind: N/A — not Kubernetes manifest") to
remove ambiguity for readers; target the table row containing `broker.yaml` and
the `Kind` column.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
hyperfleet-adapter-authoring/OWNERShyperfleet-adapter-authoring/README.mdhyperfleet-adapter-authoring/skills/SKILL.mdhyperfleet-adapter-authoring/skills/references/authoring-guide.md
|
|
||
| ## Reference material | ||
|
|
||
| The full authoring guide is at `references/authoring-guide.md` and is loaded automatically when the skill runs. |
There was a problem hiding this comment.
Fix the relative path to the authoring guide.
The path references/authoring-guide.md is incorrect relative to this README's location. Based on the repository structure, the correct path should be skills/references/authoring-guide.md.
🔧 Proposed fix
-The full authoring guide is at `references/authoring-guide.md` and is loaded automatically when the skill runs.
+The full authoring guide is at `skills/references/authoring-guide.md` and is loaded automatically when the skill runs.📝 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.
| The full authoring guide is at `references/authoring-guide.md` and is loaded automatically when the skill runs. | |
| The full authoring guide is at `skills/references/authoring-guide.md` and is loaded automatically when the skill runs. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@hyperfleet-adapter-authoring/README.md` at line 49, The README references the
wrong relative path string 'references/authoring-guide.md'; update that
occurrence in hyperfleet-adapter-authoring/README.md to
'skills/references/authoring-guide.md' so the link resolves correctly (locate
the line containing the literal 'references/authoring-guide.md' and replace it
with 'skills/references/authoring-guide.md').
rh-amarin
force-pushed
the
hyperfleet-adapter-authoring
branch
from
8770af5 to
0e82ddb
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
hyperfleet-adapter-authoring/README.md (1)
49-49: Verify the referenced file path exists.The path
references/authoring-guide.mdis mentioned but no such file exists in this PR. Looking at SKILL.md, the authoring guide is fetched from an external URL (https://raw.githubusercontent.com/openshift-hyperfleet/hyperfleet-adapter/main/docs/adapter-authoring-guide.md). Either:
- Update this reference to match the external URL approach used in SKILL.md, or
- Create the local reference file if intended
🔧 Proposed fix (option 1: reference external URL)
-The full authoring guide is at `references/authoring-guide.md` and is loaded automatically when the skill runs. +The full authoring guide is fetched from `https://raw.githubusercontent.com/openshift-hyperfleet/hyperfleet-adapter/main/docs/adapter-authoring-guide.md` and is loaded automatically when the skill runs.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@hyperfleet-adapter-authoring/README.md` at line 49, The README.md references a non-existent local file "references/authoring-guide.md"; update README.md to either point to the external URL used in SKILL.md (https://raw.githubusercontent.com/openshift-hyperfleet/hyperfleet-adapter/main/docs/adapter-authoring-guide.md) or add the missing local "references/authoring-guide.md" file; locate the reference in hyperfleet-adapter-authoring/README.md and change the path string to the external URL (or add the authored guide file under a references/ directory) so the referenced authoring guide exists when the skill runs.
🧹 Nitpick comments (1)
hyperfleet-adapter-authoring/skills/SKILL.md (1)
1492-1492: Consider adding language specifiers to fenced code blocks.Three code blocks lack language specifiers, which affects syntax highlighting:
- Line 1492: Trace output example
- Line 1590: Go template reference
- Line 1691: Log message example
🔧 Proposed fix
@@ -1489,7 +1489,7 @@ Example trace: -``` +```text Dry-Run Execution Trace ========================@@ -1587,7 +1587,7 @@ ## Go Template Quick Reference -``` +```text {{ .variableName }} Variable interpolation@@ -1688,7 +1688,7 @@ **1. Adapter Logs** Look for: -``` +```text Event execution finished: event_execution_status=successAlso applies to: 1590-1590, 1691-1691
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@hyperfleet-adapter-authoring/skills/SKILL.md` at line 1492, Add language specifiers to the three fenced code blocks that currently lack them: update the block showing the "Dry-Run Execution Trace" (the trace output example), the block containing the Go template snippet "{{ .variableName }}" (the Go template reference), and the block containing "Event execution finished: event_execution_status=success" (the log message example) to include a language token (e.g., ```text) immediately after the opening backticks so the blocks become ```text ... ``` for proper syntax highlighting.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@hyperfleet-adapter-authoring/README.md`:
- Line 49: The README.md references a non-existent local file
"references/authoring-guide.md"; update README.md to either point to the
external URL used in SKILL.md
(https://raw.githubusercontent.com/openshift-hyperfleet/hyperfleet-adapter/main/docs/adapter-authoring-guide.md)
or add the missing local "references/authoring-guide.md" file; locate the
reference in hyperfleet-adapter-authoring/README.md and change the path string
to the external URL (or add the authored guide file under a references/
directory) so the referenced authoring guide exists when the skill runs.
---
Nitpick comments:
In `@hyperfleet-adapter-authoring/skills/SKILL.md`:
- Line 1492: Add language specifiers to the three fenced code blocks that
currently lack them: update the block showing the "Dry-Run Execution Trace" (the
trace output example), the block containing the Go template snippet "{{
.variableName }}" (the Go template reference), and the block containing "Event
execution finished: event_execution_status=success" (the log message example) to
include a language token (e.g., ```text) immediately after the opening backticks
so the blocks become ```text ... ``` for proper syntax highlighting.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
hyperfleet-adapter-authoring/OWNERShyperfleet-adapter-authoring/README.mdhyperfleet-adapter-authoring/skills/SKILL.md
| @@ -0,0 +1,1758 @@ | |||
| --- | |||
There was a problem hiding this comment.
Minor consistency thing: every other skill in this repo follows the
skills//SKILL.md directory pattern (e.g., skills/hyperfleet-architecture/SKILL.md,
skills/jira-story-pointer/SKILL.md). This one has skills/SKILL.md directly. Should it be
skills/adapter-config-author/SKILL.md to match?
2 participants
This skill is useful to create new adapter configurations.
hyperfleet-adapterbinary for your platformExample of execution in an isolated claude environment:
Prompt:
result:
Summary by CodeRabbit
Documentation
Chores