Skip to content

Support clang tools version 20 #44

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

Merged
merged 4 commits into from
Feb 10, 2025
Merged

Support clang tools version 20 #44

merged 4 commits into from
Feb 10, 2025

Conversation

shenxianpeng
Copy link
Contributor

@shenxianpeng shenxianpeng commented Feb 10, 2025

Summary by CodeRabbit

  • New Features
    • Expanded compiler support by adding Clang version 20 to build and test workflows.
  • Chores
    • Streamlined the build process and improved artifact management by automatically removing oversized files.
  • Documentation
    • Updated build/test badge links and the compatibility table to reflect the new Clang version support.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Feb 10, 2025
@shenxianpeng shenxianpeng changed the title Feature/support v20 Support clang tools version 20 Feb 10, 2025
Copy link
Contributor

coderabbitai bot commented Feb 10, 2025

Walkthrough

The changes update the build workflow and documentation configuration. The build workflow file is renamed and now triggers on a new file path. The matrix strategy is extended to support clang version 20 with an accompanying matrix entry. Additionally, a new step is added to the draft-release job for deleting files larger than 2GB. The README has been updated to reflect these modifications by revising build badge links and adjusting the Clang Tools compatibility table to include clang version 20.

Changes

File Change Summary
.github/workflows/build.yml Renamed workflow from “Build amd64” to “Build”. Trigger paths updated from build-amd64.yml to build.yml. Matrix updated to include clang version 20 along with a new matrix entry. A new draft-release step has been added to delete files over 2GB.
README.md Updated build badge link to reference build.yml instead of build-amd64.yml. Adjusted Clang Tools compatibility table to add clang version 20 and revised compatibility entries accordingly.
.github/workflows/test.yml Added clang version 20 to the existing matrix of clang versions.

Sequence Diagram(s)

sequenceDiagram
    participant GH as GitHub Events
    participant BuildWF as Build Workflow
    participant MatrixJob as Build Job (Matrix)
    participant Release as Draft-Release Job

    GH->>BuildWF: Trigger on push/PR (build.yml)
    BuildWF->>MatrixJob: Execute build matrix (including clang 20)
    MatrixJob->>BuildWF: Return build artifacts
    BuildWF->>Release: Initiate release steps
    Release->>Release: Execute deletion of files >2GB
Loading

Possibly related PRs

  • feat: support clang 19 #36: The changes in the main PR, which include adding support for Clang version 20, are related to the retrieved PR that added support for Clang version 19, as both involve modifications to the clang-version matrix in the workflow configuration.

Suggested labels

enhancement

Poem

In the code garden, I hop with glee,
Clang 20 jumps in elegantly.
Workflows refined, artifacts kept light,
Giant files vanish from my sight.
A rabbit prances through changes so bold,
Celebrating new paths in code untold! 🐇🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 115e258 and d7e6dd6.

📒 Files selected for processing (1)
  • .github/workflows/test.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/test.yml (1)

17-17: Extend Clang Version Matrix with v20

Adding version 20 to the clang-version list is a straightforward update that expands build and test coverage to support the latest clang version. This aligns with the recent README and build workflow updates. Please ensure that all steps using clang tools (download, checksum verification, execution) are compatible with clang v20.


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

🧹 Nitpick comments (4)
.github/workflows/build.yml (1)

198-200: New Step: Delete Files Over 2GB
A new draft-release step has been introduced to delete any files larger than 2GB using the find command.
While this helps in managing oversized artifacts, please double-check that the command’s scope does not unintentionally remove critical files. Consider adding logging or a dry-run mode if further safety is desired.

README.md (3)

3-3: Commented Out Test Badge
The previously included test badge is now commented out. If it’s no longer needed, consider removing this commented-out line to keep the README clean and avoid confusion.


5-5: Image Alt Text for Platform Badge
The platform badge image on line 5 does not include alternate text (alt text), which is important for accessibility and markdown lint compliance.
Consider updating it as follows:

-![](https://img.shields.io/badge/platform-linux--64%20%7C%20win--64%20%7C%20osx--64%20-blue)
+![Platform: linux 64 | win 64 | osx 64](https://img.shields.io/badge/platform-linux--64%20%7C%20win--64%20%7C%20osx--64%20-blue)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

5-5: Images should have alternate text (alt text)
null

(MD045, no-alt-text)


12-13: Markdown Table Header Column Count
The table header appears to have an extra column due to a trailing pipe, resulting in an inconsistency with the expected 16 columns. This may lead to column misalignment in the rendered table.
Please adjust the header row by removing any superfluous delimiter so that it aligns with the rest of the table rows. For example:

-| Clang Tools |OS/Version |20|19|18 |17 |16 |15 |14 |13 |12 |11 |10 |9  |8  |7  |
+| Clang Tools | OS/Version | 20 | 19 | 18 | 17 | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9 | 8 | 7 |

Be sure to update the divider row and all subsequent rows accordingly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 665be88 and 115e258.

📒 Files selected for processing (2)
  • .github/workflows/build.yml (3 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

5-5: Images should have alternate text (alt text)
null

(MD045, no-alt-text)


23-23: Table column count
Expected: 16; Actual: 17; Too many cells, extra data will be missing

(MD056, table-column-count)

⏰ Context from checks skipped due to timeout of 90000ms (20)
  • GitHub Check: build (10, windows)
  • GitHub Check: build (10, macosx)
  • GitHub Check: build (10, linux)
  • GitHub Check: build (11, windows)
  • GitHub Check: build (11, macosx)
  • GitHub Check: build (11, linux)
  • GitHub Check: build (12, windows)
  • GitHub Check: build (12, macosx)
  • GitHub Check: build (12, linux)
  • GitHub Check: build (12.0.1, windows)
  • GitHub Check: build (12.0.1, macosx)
  • GitHub Check: build (12.0.1, linux)
  • GitHub Check: build (13, windows)
  • GitHub Check: build (13, macosx)
  • GitHub Check: build (13, linux)
  • GitHub Check: build (14, windows)
  • GitHub Check: build (14, linux)
  • GitHub Check: build (15, windows)
  • GitHub Check: build (15, linux)
  • GitHub Check: build (16, linux)
🔇 Additional comments (6)
.github/workflows/build.yml (5)

1-1: Workflow Name Update: "Build"
The workflow name has been updated from "Build amd64" to "Build", reflecting the streamlined nature of this configuration.


7-7: Trigger Paths Updated
The trigger paths have been updated to reference the new file path (.github/workflows/build.yml) instead of the old one. This ensures that pushes and pull requests only trigger the intended workflow file.


11-11: Pull Request Trigger Path Adjustment
The pull_request trigger now correctly monitors changes to the updated workflow file, aligning with the push trigger changes.


23-23: Inclusion of Clang Version 20 in Matrix
The matrix strategy has been updated to include clang-version: [ 20, 19, 18, 17, 16, 15, 14, 13, 12.0.1, 12, 11, 10, 9, 8, 7 ].
This change ensures that clang version 20 is prioritized. Please verify that all conditional expressions (e.g., numeric comparisons like >= 9) correctly handle the new version (an integer 20).


26-27: New Matrix Include Entry for Clang 20
A new entry has been added to the matrix include block for clang version 20 with the corresponding release llvm-project-20.0.0.src.
This entry correctly maps clang version 20 to its release version.

README.md (1)

4-4: Build Badge Link Update
The build badge now correctly points to the new workflow file (build.yml) instead of the old build-amd64.yml. This ensures that the badge reflects the current build status accurately.

@shenxianpeng shenxianpeng merged commit 1b0b1cd into master Feb 10, 2025
22 of 47 checks passed
@shenxianpeng shenxianpeng deleted the feature/support-v20 branch February 10, 2025 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant