[Comgr] Document API versioning rule in AGENT_CONVENTIONS.md#3135
Merged
Conversation
Add an explicit rule to the PR-workflow section: every commit that adds a public AMD_COMGR_API function must bump the minor version and tag the new prototype with a fresh AMD_COMGR_VERSION_X_Y macro. This codifies the policy that surfaced when #3008 added amd_comgr_hotswap_rewrite_with_options under the already-used 3.3 version without bumping. The rule notes the one-bump-per-commit model, that we don't wait for a release to bump, and that check_api_consistency.py only enforces a version floor (>=) so it cannot catch version reuse. Changes: - AGENT_CONVENTIONS.md: add "Bump the version when adding a public API" subsection under section 4 (PR workflow).
chinmaydd
approved these changes
Jun 30, 2026
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
2 participants
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.
Summary
Adds an explicit API-versioning rule to
amd/comgr/AGENT_CONVENTIONS.md(section 4, PR workflow): every commit that adds a publicAMD_COMGR_APIfunction must bump the minor version inVERSION.txtand tag the new prototype with a freshAMD_COMGR_VERSION_X_Ymacro.This codifies the policy that surfaced when #3008 added
amd_comgr_hotswap_rewrite_with_optionsunder the already-used3.3version without bumping (fixed in its follow-up #3134).The rule captures:
exportmap.inunder a version node matching the new tag.check_api_consistency.pyonly enforcesVERSION.txt >=the highest macro, so it cannot catch version reuse — verify the bump by hand.Changes
AGENT_CONVENTIONS.md: add the "Bump the version when adding a public API" subsection.