Add agent maintenance infrastructure for SDK documentation sync#16
Open
Add agent maintenance infrastructure for SDK documentation sync#16
Conversation
This commit introduces a comprehensive system for keeping Claude agent documentation synchronized with Flutter SDK changes. ## Added Files ### Agent & Configuration - `.claude/agents/cloudx-flutter-agent-maintainer.md`: Autonomous agent for detecting SDK changes and syncing agent documentation - `.claude/maintenance/SDK_VERSION.yaml`: Source of truth for SDK version (v0.18.0) and critical API signatures ### GitHub Workflows - `.github/workflows/sync-agent-repo.yml`: Detects API changes on push/PR and notifies developers to sync agent docs - `.github/workflows/validate-maintainer-agent.yml`: Validates SDK version consistency between pubspec.yaml and SDK_VERSION.yaml ### Scripts - `scripts/sync_to_agent_repo.sh`: Helper script to clone agent repository for syncing ## Key Features **Maintainer Agent:** - Autonomously detects SDK version changes (pubspec.yaml → SDK_VERSION.yaml) - Auto-detects API changes by diffing public API files - Updates agent documentation with version strings and API signatures - Validates changes before committing **Sync Workflow:** - Triggers on push/PR to main when SDK files change - Creates tracking issues for direct commits (assigned to committer) - Posts PR comments for pull requests - Includes failure handling with detailed error reporting **Validation Workflow:** - Ensures SDK_VERSION.yaml stays in sync with pubspec.yaml - Validates maintainer agent documentation structure - Detects API changes requiring agent sync in PRs ## Documentation Updates **SDK_VERSION.yaml includes:** - Current SDK version: 0.18.0 (previously 0.1.2) - Fixed initialize() parameter: testMode (was incorrectly documented as allowIosExperimental) - Complete widget constructors with all parameters (CloudXBannerView, CloudXMRECView) - New CloudXAdViewController documentation - Updated iOS support status (not_supported vs experimental) - Comprehensive API signatures for all public methods **Maintainer Agent includes:** - Flutter-specific file paths and patterns - Version 0.18.0 examples throughout - Correct widget references (removed non-existent CloudXNativeView) - Updated repository name (cloudx-flutter) ## Workflow Improvements Both workflows now include: - Explicit permissions (security best practice) - Dual trigger support (push + pull_request) - Conditional logic based on event type - Main branch only (removed develop branch) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR introduces a comprehensive system for keeping Claude agent documentation synchronized with Flutter SDK changes.
What's Added
🤖 Agent & Configuration
.claude/agents/cloudx-flutter-agent-maintainer.md: Autonomous agent for detecting SDK changes and syncing agent documentation.claude/maintenance/SDK_VERSION.yaml: Source of truth for SDK version (v0.18.0) and critical API signatures🔄 GitHub Workflows
.github/workflows/sync-agent-repo.yml: Detects API changes on push/PR and notifies developers to sync agent docs.github/workflows/validate-maintainer-agent.yml: Validates SDK version consistency between pubspec.yaml and SDK_VERSION.yaml📜 Scripts
scripts/sync_to_agent_repo.sh: Helper script to clone agent repository for syncingKey Features
Maintainer Agent
Sync Workflow
Validation Workflow
Documentation Updates
SDK_VERSION.yaml Updates
initialize()parameter:testMode(was incorrectly documented asallowIosExperimental)CloudXBannerView,CloudXMRECView)CloudXAdViewControllerdocumentationMaintainer Agent Updates
CloudXNativeView)cloudx-flutter)Workflow Improvements
Both workflows now include:
Validation Workflow Will Fail
The
validate-maintainer-agent.ymlworkflow currently checks for sections that don't exist in the maintainer agent:Actual sections in maintainer agent:
Options to fix:
Decision needed: Should be addressed in a follow-up PR or before merging this one.
Script Not Yet Implemented
The
scripts/sync_to_agent_repo.shscript is referenced but may need:cloudx-sdk-agentsrepositoryTesting
Related
This matches the infrastructure in the Android SDK repo for consistency.
🤖 Generated with Claude Code