-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add duplicate dependencies check in CI #9283
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| """ | ||
| A script to check for duplicated dependencies across [dependencies] and [dev-dependencies] | ||
| in all Cargo.toml files in the workspace. | ||
|
|
||
| This is useful for CI to enforce clean separation between runtime and dev-only dependencies. | ||
|
|
||
| A duplicated dependency is one that appears in both sections with the exact same configuration, | ||
| which is usually unnecessary and should be avoided. | ||
|
|
||
| # Example | ||
|
|
||
| ```sh | ||
| python3 -m pip install toml | ||
| .github/scripts/check-duplicated-deps.py | ||
| """ | ||
|
|
||
| #!/usr/bin/env python3 | ||
| import os | ||
| import sys | ||
|
|
||
| import toml | ||
|
|
||
|
|
||
| def find_cargo_toml_files(root='.'): | ||
| cargo_files = [] | ||
| for dirpath, dirnames, filenames in os.walk(root): | ||
| if 'target' in dirnames: | ||
| dirnames.remove('target') | ||
| if 'Cargo.toml' in filenames: | ||
| cargo_files.append(os.path.join(dirpath, 'Cargo.toml')) | ||
| return cargo_files | ||
|
|
||
| def parse_dependencies(file_path): | ||
| try: | ||
| data = toml.load(file_path) | ||
| except Exception as e: | ||
| print(f"Error parsing {file_path}: {e}", file=sys.stderr) | ||
| return {}, {} | ||
|
|
||
| deps = data.get("dependencies", {}) | ||
| dev_deps = data.get("dev-dependencies", {}) | ||
| return deps, dev_deps | ||
|
|
||
| def format_dep_config(config): | ||
| if isinstance(config, str): | ||
| return {"version": config} | ||
| elif isinstance(config, dict): | ||
| return dict(sorted(config.items())) | ||
| else: | ||
| return {} | ||
|
|
||
| def main(): | ||
| files = find_cargo_toml_files() | ||
| any_duplicates = False | ||
|
|
||
| for file_path in files: | ||
| deps, dev_deps = parse_dependencies(file_path) | ||
|
|
||
| duplicates = [] | ||
| for dep_name, dep_config in deps.items(): | ||
| if dep_name in dev_deps: | ||
| config1 = format_dep_config(dep_config) | ||
| config2 = format_dep_config(dev_deps[dep_name]) | ||
| if config1 == config2: | ||
| duplicates.append(dep_name) | ||
|
|
||
| if duplicates: | ||
| any_duplicates = True | ||
| print(f"❌ Duplicated dependencies in {file_path}:") | ||
| for dep in sorted(duplicates): | ||
| print(f" - {dep}") | ||
|
|
||
| if any_duplicates: | ||
| print("\n🚫 CI check failed due to duplicated dependencies.") | ||
| sys.exit(1) | ||
| else: | ||
| print("✅ No duplicated dependencies found.") | ||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What you mean with "exact same configuration"? Features? Or Version / Path stuff?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All of that, same features, same path, same version, basically if we consider the dependency as
name = valuewith "exact same configuration" I mean "same value"