-
Notifications
You must be signed in to change notification settings - Fork 5
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
Temporarily lock clang-format to v18.x to resolve lint failures. #44
Conversation
WalkthroughThe pull request updates the version specification for Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant CI
participant Linter
Developer->>CI: Push changes
CI->>Linter: Run linting
Linter->>Linter: Check clang-format version
Linter-->>CI: Report linting results
CI-->>Developer: Provide feedback
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
lint-requirements.txt (2)
1-2
: LGTM! Consider adding a TODO comment for future reference.The change effectively locks clang-format to the 18.x series, which aligns with the PR objectives and resolves the immediate lint failures. The comment clearly explains the reason for this temporary lock.
To further improve maintainability, consider adding a TODO comment with a link to an issue tracking the need to upgrade to clang-format v19 in the future. This will help ensure that this temporary fix isn't forgotten.
Here's a suggested addition to the comment:
# Lock to v18.x until we can upgrade our code to meet v19's formatting standards. +# TODO: Upgrade to clang-format v19 (see issue #<number>) clang-format~=18.1
Line range hint
1-4
: Create an issue to track the upgrade to clang-format v19.While this change effectively resolves the immediate problem, it's important to ensure that the upgrade to clang-format v19 isn't overlooked in the future.
Would you like me to create a GitHub issue to track the need for upgrading to clang-format v19? This will help ensure that this temporary fix is revisited and a more permanent solution is implemented in due course.
References
#45
Description
This PR locks the clang-format version to 18.1.8 (which is the latest version 18 release in PyPI) as a temporary solution to fix the lint workflow failure due to the new major release of clang-format (version 19). We will fix this properly later by adapting clang-format version 19.
Validation performed
Ensure the workflow passed after locking clang-format version: https://github.com/LinZhihao-723/log-surgeon/actions/runs/11040699328
Summary by CodeRabbit
clang-format
to lock it to the 18.x series for improved compatibility.