fix: rename PyPI package agent-runtime → agentmesh-runtime (name collision with AutoGen)#444
Conversation
ADO requires service connection names at compile time for task authorization. Runtime variables cannot be used for connectedservicename. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…e name collision Co-authored-by: imran-siddique <45405841+imran-siddique@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/agent-governance-toolkit/sessions/bb546e84-e84d-49c1-8ab4-8ccc8013f4e2
🤖 AI Agent: breaking-change-detector — Summary🔍 API Compatibility ReportSummaryThe pull request renames the PyPI package Findings
Migration Guide
Conclusion✅ No breaking changes detected. This is a non-breaking change limited to package naming on PyPI. Downstream users only need to update their dependency declarations. |
🤖 AI Agent: test-generator — `packages/agent-compliance/src/agent_compliance/__init__.py`🧪 Test Coverage Analysis
|
There was a problem hiding this comment.
🤖 AI Agent: code-reviewer
Review Summary
This PR addresses a critical issue of a naming collision on PyPI by renaming the agent-runtime package to agentmesh-runtime. The changes are extensive, touching 26 files, including documentation, dependency declarations, and CI pipelines. The renaming is consistent across the repository, and no directory paths or import paths were altered. The changes appear to be straightforward and primarily involve renaming the package in various files.
Below is a detailed review of the PR:
🔴 CRITICAL
-
Dependency Confusion Risk:
- The PR description mentions that the rename is due to a name collision with the AutoGen team's
agent-runtimepackage on PyPI. However, there is no explicit verification in the PR thatagentmesh-runtimeis registered and owned by the repository maintainers. This creates a potential dependency confusion vulnerability ifagentmesh-runtimeis not properly registered and controlled by the team. - Action: Ensure that
agentmesh-runtimeis registered on PyPI and owned by the appropriate account before merging this PR. Add a comment in the PR confirming this step has been completed.
- The PR description mentions that the rename is due to a name collision with the AutoGen team's
-
Backward Compatibility:
- The PR does not address backward compatibility for users who may have already installed
agent-runtime. This could lead to broken builds for existing users. - Action: Consider publishing a transitional release of
agent-runtimethat depends onagentmesh-runtimeand emits a deprecation warning. This will give users time to migrate to the new package name.
- The PR does not address backward compatibility for users who may have already installed
🟡 WARNING
- Breaking Change:
- The rename of the PyPI package from
agent-runtimetoagentmesh-runtimeis a breaking change for any users relying on the old package name. While this is unavoidable due to the name collision, it should be clearly documented in the release notes and communicated to users. - Action: Update the release notes to include a clear migration guide for users, including instructions to uninstall
agent-runtimeand installagentmesh-runtime.
- The rename of the PyPI package from
💡 SUGGESTIONS
-
Test Coverage:
- While the PR mentions that directory paths and import paths remain unchanged, it is still important to verify that the test suite covers all scenarios where the renamed package is used.
- Action: Run the full test suite and confirm that all tests pass. If possible, add a test to ensure that the renamed package (
agentmesh-runtime) is correctly imported and used in the codebase.
-
Documentation Updates:
- The documentation updates are thorough, but there are some minor inconsistencies in formatting due to merge conflicts (e.g., duplicate lines in
QUICKSTART.mdanddocs/tutorials/README.md). - Action: Clean up the merge conflict artifacts to ensure the documentation is clear and consistent.
- The documentation updates are thorough, but there are some minor inconsistencies in formatting due to merge conflicts (e.g., duplicate lines in
-
CI/CD Pipeline:
- The CI/CD pipeline configuration files have been updated to reflect the new package name. However, it is important to verify that the pipeline is correctly publishing the renamed package to PyPI.
- Action: Test the CI/CD pipeline in a staging environment to ensure the renamed package is published correctly.
-
Versioning:
- The PR does not specify whether the version of the renamed package will be updated. Since this is a breaking change, it would be appropriate to increment the major version number of the package.
- Action: Ensure that the version number of
agentmesh-runtimeis incremented to reflect the breaking change.
-
Communication Plan:
- Given the scope of this change, it is important to communicate the rename to the user community.
- Action: Consider adding a deprecation notice to the
agent-runtimerepository (if it exists) and updating any external documentation or references to the old package name.
Final Recommendation
- Address the CRITICAL issues before merging this PR.
- Consider the WARNING and SUGGESTION points to ensure a smooth transition for users and maintain backward compatibility where possible.
- Once the above points are resolved, this PR can be merged.
🤖 AI Agent: docs-sync-checker — Issues Found📝 Documentation Sync ReportIssues Found
Suggestions
If everything looks good, say ✅ Documentation is in sync. |
🤖 AI Agent: security-scanner — Security Review of PR: Rename PyPI Package `agent-runtime` → `agentmesh-runtime`Security Review of PR: Rename PyPI Package
|
| Finding | Severity | Action Required |
|---|---|---|
| Dependency confusion risk | 🔴 CRITICAL | Register agentmesh-runtime on PyPI immediately and add pre-merge checks. |
| Backward compatibility breakage | 🟠 HIGH | Maintain a transitional alias and document the migration path. |
| Supply chain integrity | 🟡 MEDIUM | Add hash pinning and integrity checks in CI/CD pipelines. |
| Documentation merge conflicts | 🔵 LOW | Resolve all merge conflicts before merging. |
| No changes to import paths or logic | 🔵 LOW | Verify no functional changes were introduced and add downstream integration tests. |
Final Recommendation
Do not merge this PR until the following actions are taken:
- Register
agentmesh-runtimeon PyPI to prevent dependency confusion. - Resolve all merge conflicts in documentation files.
- Add CI/CD checks for dependency integrity and unresolved conflict markers.
- Document the migration path and consider maintaining a transitional alias for
agent-runtime.
Once these issues are addressed, the PR can be safely merged.
Rebased version of #440 (which had merge conflicts after #439 merged).
Renames the PyPI distribution name from agent-runtime to agentmesh-runtime, since agent-runtime on PyPI is owned by AutoGen team.
Changes across 26 files: pyproject.toml, dependency declarations, docs, tutorials, CI pipelines. Directory paths and import paths unchanged.
Closes #437