Document Platform consumer release version ownership

[glenn-jocher]

Document the single release owner: the upstream Platform API contract's info.version must equal the generated SDK package version. Explicitly prohibit SDK overrides, independent patch increments, and editing generated versions; give the release sequence for SDK-only fixes, wheel verification before consumer updates, and forward-only recovery from already-published mismatches.

The enforcement and SDK guidance change is ultralytics/sdk#75; merge this documentation after that repair so instructions and automation agree.

Documentation only; reviewed against the API contract and SDK synchronization/publishing workflows, with git diff --check passing.

🛠️ PR Summary

_{Made with ❤️ by Ultralytics Actions}

🌟 Summary

Documented that the upstream Platform API contract owns the ultralytics-platform SDK version, ensuring both versions remain synchronized through the documented release workflow.

📊 Key Changes

• Added a critical release policy to AGENTS.md requiring the SDK version to match the API contract’s info.version.
• Prohibited manually setting python.version, independent SDK patch bumps, and hand-editing generated versions.
• Defined the release sequence for SDK-only fixes: merge the fix, coordinate an API contract version bump and deployment, then allow SDK automation to synchronize and publish.
• Required verification of the live API contract and published wheel before updating consumer dependencies.
• Documented forward-only recovery when a published SDK is ahead of the API, including advancing the API beyond all published SDK versions.

🎯 Purpose & Impact

• Maintainers now have explicit guidance for coordinating Platform API and SDK releases and recovering from version mismatches.
• The policy is confined to Platform consumer workflows and does not change the general-purpose converter or third-party API version configuration.
• No runtime or generated-code behavior changes.

[UltralyticsAssistant]

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/openapi 🚀 PR! This automated message confirms your contribution was received, and an Ultralytics engineer will assist with the review. To ensure a seamless integration of your work, please review the following checklist:

• ✅ Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
• ✅ Synchronize with Source: Confirm your PR is synchronized with the ultralytics/openapi main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
• ✅ Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
• ✅ Update Documentation: Update the relevant documentation for any new or modified features.
• ✅ Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
• ✅ Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
• ✅ Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

[UltralyticsAssistant]

🔍 PR Review

_{Made with ❤️ by Ultralytics Actions}

Reviewed the single AGENTS.md change. The documented ownership rule is clear, but it is not yet consistent with the current SDK synchronization workflow and SDK repository guidance, creating a concrete release-process regression risk.

💬 Posted 1 inline comment

• ⚠️ HIGH AGENTS.md:43 This policy conflicts with the current SDK owner and automation. ultralytics/sdk CI still writes python.version when the previous SDK version is ahead of the contract and independently increments the patch when generated output changes at an unchanged version; its AGENTS.md also instructs maintainers to update python.version for intentional SDK changes. A maintainer following this new guidance can therefore still get an independently versioned SDK, or follow contradictory instructions a…

[UltralyticsAssistant]

🔍 PR Review 2

_{Made with ❤️ by Ultralytics Actions}

Since the previous review, the SDK-side enforcement and guidance repair has merged, resolving the earlier workflow conflict and aligning automation with this policy. (github.com) The current AGENTS.md-only diff is consistent and introduces no genuine issues. LGTM.

[UltralyticsAssistant]

🎉 PR #54 has been merged—thank you, @glenn-jocher!

“Alone we can do so little; together we can do so much.” — Helen Keller

This documentation makes that collaboration concrete by clarifying how the Platform API contract and ultralytics-platform SDK stay synchronized, including coordinated releases, verification, and forward-only recovery for version mismatches.