@@ -15,9 +15,8 @@ Starting from version **v1.0.0**, `cpp-linter-hooks` has migrated from using the
1515
1616| Aspect | Before (< v1.0.0) | After (≥ v1.0.0) |
1717| --------| -------------------| -------------------|
18- | ** Installation** | ` clang-tools ` package (binary management) | Python wheel packages (` clang-format ` , ` clang-tidy ` ) |
19- | ** Distribution** | Single package for both tools | Separate packages for each tool |
20- | ** Version Control** | Limited version flexibility | Enhanced version management with pip |
18+ | ** Installation** | Install from GitHub release | Install with from PyPI |
19+ | ** Distribution** | Binary packages | Python wheel packages |
2120| ** Performance** | Standard performance | Optimized wheel packages |
2221
2322### Implementation Details
@@ -28,55 +27,21 @@ Starting from version **v1.0.0**, `cpp-linter-hooks` has migrated from using the
2827
2928## Breaking Changes
3029
31- ### For End Users
32-
33- > ** No breaking changes for end users**
30+ ** No breaking changes for end users**
3431
3532- Your existing ` .pre-commit-config.yaml ` files will continue to work without modification
3633- All hook configurations remain backward compatible
3734- No changes required to your workflow
3835
3936## Migration Steps
4037
41- ### For End Users
42-
4338** No action required!** Your existing configuration will continue to work seamlessly.
4439
4540However, we recommend updating to the latest version for:
4641- Better performance
4742- Enhanced reliability
4843- Latest features and bug fixes
4944
50- #### Example Configuration (No Changes Needed)
51-
52- ``` yaml
53- repos :
54- - repo : https://github.com/cpp-linter/cpp-linter-hooks
55- rev : v1.0.0 # Use the latest version
56- hooks :
57- - id : clang-format
58- args : [--style=Google]
59- - id : clang-tidy
60- args : [--checks=-*,readability-*]
61- ` ` `
62-
63- ## Troubleshooting
64-
65- ### Common Issues
66-
67- #### Issue: Tool not found after migration
68- **Solution**: Clear your pre-commit cache:
69- ` ` ` bash
70- pre-commit clean
71- pre-commit install
72- ```
73-
74- #### Issue: Version mismatch errors
75- ** Solution** : Ensure you're using the latest version of ` cpp-linter-hooks ` :
76- ``` yaml
77- rev : v1.0.0 # Update to latest version
78- ` ` `
79-
8045## Support
8146
8247If you encounter issues after migration:
0 commit comments