fix: update all references to use new PyPI package names#453
fix: update all references to use new PyPI package names#453imran-siddique merged 1 commit intomicrosoft:mainfrom
Conversation
Replace all remaining references to old package names: - agent-lightning → agentmesh-lightning - agent-runtime → agentmesh-runtime Updated: README, QUICKSTART, CONTRIBUTING, PUBLISHING, tutorials, workflows, scripts, and package metadata. Also fixed merge conflict markers in QUICKSTART.md and docs/tutorials/README.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
🤖 AI Agent: security-scanner — Security Review of PR: `fix: update all references to use new PyPI package names`Security Review of PR:
|
There was a problem hiding this comment.
🤖 AI Agent: code-reviewer
Review of Pull Request: fix: update all references to use new PyPI package names
Summary
This pull request updates all references to the old PyPI package names (agent-lightning → agentmesh-lightning, agent-runtime → agentmesh-runtime) across the repository. It also resolves merge conflict markers in QUICKSTART.md and docs/tutorials/README.md.
Feedback
🔴 CRITICAL
- Dependency Confusion Risk:
- The script
scripts/check_dependency_confusion.pyis updated to include the new package names (agentmesh-lightningandagentmesh-runtime). However, there is no explicit check to ensure that the old package names (agent-lightningandagent-runtime) are no longer being used in the repository or by any external dependencies. - Action: Add a validation step in the CI pipeline to ensure that no references to the old package names exist in the repository or are being pulled in as dependencies. This will prevent dependency confusion attacks where an attacker could publish malicious packages under the old names.
- The script
🟡 WARNING
- Backward Compatibility:
- Renaming the PyPI packages (
agent-lightning→agentmesh-lightning,agent-runtime→agentmesh-runtime) is a breaking change for users who rely on the old package names in theirrequirements.txtorsetup.pyfiles. - Action: Clearly document this breaking change in the
RELEASE_NOTES_v1.0.0.mdand provide migration instructions for users to update their dependencies. Consider publishing a final version of the old packages with a deprecation notice to guide users to the new package names.
- Renaming the PyPI packages (
💡 SUGGESTIONS
-
Merge Conflict Markers:
- The merge conflict markers in
QUICKSTART.mdanddocs/tutorials/README.mdwere removed, but there is no test or validation in the CI pipeline to ensure that such markers are not accidentally committed in the future. - Action: Add a linting step in the CI pipeline to detect and fail the build if merge conflict markers (
<<<<<<<,=======,>>>>>>>) are present in any file.
- The merge conflict markers in
-
Documentation Consistency:
- The
CONTRIBUTING.mdfile still mentions "seven packages" in the description, but the table lists eight packages. This discrepancy might confuse contributors. - Action: Update the description in
CONTRIBUTING.mdto reflect the correct number of packages.
- The
-
PyPI Metadata:
- The
pyproject.tomlfile foragent-lightningwas updated to use the new nameagentmesh-lightning. However, thedescriptionfield still refers to "agent-lightning." - Action: Update the
descriptionfield inpyproject.tomlto reflect the new package name.
- The
-
Testing:
- While the changes appear to be straightforward, it's critical to ensure that the renaming does not break any functionality.
- Action: Add a test to verify that the new package names are correctly resolved and imported in the codebase. For example, a simple test could attempt to import the renamed packages and verify their functionality.
-
Version Pinning:
- The
QUICKSTART.mdand other documentation files suggest installing the packages without specifying version constraints (e.g.,pip install agentmesh-lightning). This could lead to unexpected issues if breaking changes are introduced in future versions of the packages. - Action: Recommend pinning specific versions of the packages in the documentation to ensure stability for users.
- The
Summary of Actions
- Critical: Add a CI validation step to ensure no references to old package names exist and prevent dependency confusion.
- Warning: Document the breaking change in
RELEASE_NOTES_v1.0.0.mdand provide migration instructions. - Suggestions:
- Add a linting step to detect merge conflict markers.
- Fix the inconsistency in the number of packages mentioned in
CONTRIBUTING.md. - Update the
descriptionfield inpyproject.tomlforagentmesh-lightning. - Add tests to verify the correctness of the renamed packages.
- Recommend version pinning in the documentation.
Final Assessment
The changes in this pull request are necessary and well-executed, but the critical issues around dependency confusion and backward compatibility must be addressed before merging. Additionally, implementing the suggested improvements will enhance the robustness and usability of the repository.
Comprehensive sweep to replace all remaining old PyPI package names with their new names:
Also fixes merge conflict markers in QUICKSTART.md and docs/tutorials/README.md.
Files changed: README, QUICKSTART, CONTRIBUTING, RELEASE_NOTES_v1.0.0, tutorials, 3 GitHub workflows, scripts/check_dependency_confusion.py, packages/agent-lightning/{README,pyproject.toml}
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com