Initial skeleton for using ABI checks for automated versioning checks #1612
Conversation
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
- Each project/package has a `VERSION` file and a `versioning.yml` file. - The VERSION file is a text file and contains the major.minor.patch version and a md5sum of the files when the version was last updated — the intention here is to force a git conflict when two PRs are updating the version and their CI has already run. The VERSION file is the single source of truth for the version. - The `versioning.yml` is used for various specs: specifying the files to generate the md5sum from, which build products to check for ABI breaks, and some other miscellaneous parameters. - `cmake/rocm_versioning.cmake` is provided to parse VERSION file and get the values into CMake. - `.github/workflows/abi-guard.yml` is a reusable workflow for performing ABI checks; it uses `scripts/abi-guard.py` and is passed a `versioning.yml`. - `scripts/abi-guard.py` is provided to do various workflows: check for ABI breakages (via libabigail), compute the hash for a version change, etc. - This PR includes a VERSION and versioning.yml for rocprofiler-sdk according to this schema
github-actions
bot
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces an ABI (Application Binary Interface) guard system for versioning and compatibility checking across ROCm projects. The implementation uses libabigail to detect API/ABI changes and enforce semantic versioning policies.
- Adds a Python script (
abi-guard.py) for version management, hash computation, and ABI checking - Provides a Jinja2 template for generating versioning configuration files
- Integrates versioning infrastructure into the build system via CMake modules
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/abi-guard.py | Main Python tool for ABI checking, version management, and hash computation |
| scripts/templates/versioning.yml.j2 | Jinja2 template for generating versioning configuration files |
| scripts/requirements.txt | Python dependencies for the ABI guard tool |
| projects/rocprofiler-sdk/versioning.yml | Example versioning configuration for rocprofiler-sdk project |
| projects/rocprofiler-sdk/VERSION | Updated version file with hash comment |
| cmake/rocm_versioning.cmake | CMake module for reading version files and installing version artifacts |
| projects/rocprofiler-sdk/CMakeLists.txt | Integration of versioning system into project build configuration |
| projects/rocprofiler-sdk/cmake/rocprofiler_config_install.cmake | Installation of version files |
| CONTRIBUTING.md | Documentation on versioning practices and workflows |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Motivation
Currently, project versioning is done ad-hoc and lacks automated enforcement. This PR is a prototype for automating checks which enforce versioning updates. A reusable github workflow and an example of using this automated workflow for rocprofiler-sdk will be included soon.
The workflow relies on a combination of libabigail and (per-project)
VERSIONandversioning.ymlfiles. The single source of truth for the project's version is in the VERSION file. Theversioning.ymlis used for the automated workflows using libabigail.Enforcing Versioning Updates
sourcesorheaderssection of theversioning.ymlis modified (excluding modifications solely to code comments and/or formatting), a patch version increase is required.Please see the updates to the
CONTRIBUTING.mdfor more details.Technical Details
VERSIONfile and aversioning.ymlfile.VERSIONfile is a text file and contains the<major>.<minor>.<patch>version and a md5sum of the files when the version was last updatedversioning.ymlis used for various specs: specifying the files to generate the md5sum from, which build products to check for ABI breaks, and some other miscellaneous parameters.cmake/rocm_versioning.cmakeis provided to parse VERSION file and get the values into CMake. An example of its usage is in rocprofiler-sdk..github/workflows/abi-guard.ymlis a reusable workflow for performing ABI checks; it usesscripts/abi-guard.pyand is passed aversioning.yml.scripts/abi-guard.pyis provided to do various workflows: check for ABI breakages (via libabigail), update aVERSIONfile, compute the hash for a version change, etc.Test Plan
VERSIONand/orversioning.ymlfile.Test Result
Submission Checklist