Skip to content

Conversation

LinZhihao-723
Copy link
Member

@LinZhihao-723 LinZhihao-723 commented Jun 10, 2025

Description

The changes in #925 bump antlr version to 4.13.2.
The changes in #969 bump ystdlib to the latest commit, and drop outcome dependency.

However, the version changes are not reflected in the dev-guide documents. This PR updates these version changes to reflect the latest code base.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • Manually compared the task file and the doc to ensure they aligned.
  • Ensure all workflows pass.

Summary by CodeRabbit

  • Documentation
    • Updated documentation to reflect newer versions and commit hashes of dependencies.
    • Removed the "outcome" library from the list of dependencies.

@LinZhihao-723 LinZhihao-723 requested a review from a team as a code owner June 10, 2025 20:48
Copy link
Contributor

coderabbitai bot commented Jun 10, 2025

Walkthrough

The documentation for the CLP core build process was updated to reflect new versions of dependencies: the ANTLR library version was incremented, the "outcome" library was removed from the list, and the commit hash for "ystdlib-cpp" was updated. No other documentation or code changes were made.

Changes

File(s) Change Summary
docs/src/dev-guide/components-core/index.md Updated ANTLR version, removed "outcome" library, changed "ystdlib-cpp" commit hash

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d994430 and db5421f.

📒 Files selected for processing (1)
  • docs/src/dev-guide/components-core/index.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: lint-check (macos-latest)
  • GitHub Check: lint-check (ubuntu-latest)
🔇 Additional comments (2)
docs/src/dev-guide/components-core/index.md (2)

52-52:

❓ Verification inconclusive

Validate updated ystdlib-cpp commit hash
Ensure the commit hash d80cf86 exists in the ystdlib-cpp repository and that any submodule or download task reflects this new commit.


🏁 Script executed:

#!/bin/bash
# Check remote repository for the specified commit
git ls-remote https://github.com/y-scope/ystdlib-cpp.git d80cf86

Length of output: 66


Confirm ystdlib-cpp commit hash
I ran git ls-remote https://github.com/y-scope/ystdlib-cpp.git d80cf86 and no matching commit was found. Please verify that the commit hash d80cf86 exists in the ystdlib-cpp repository and update any submodule or download task accordingly.

• File: docs/src/dev-guide/components-core/index.md
• Line: 52


39-39:

✅ Verification successful

Validate ANTLR version bump
Confirm that all build and download scripts, including Taskfile.yml and tools/scripts/deps-download/init.sh, have been updated to download ANTLR v4.13.2 and that the version constraint aligns across the codebase.


🏁 Script executed:

#!/bin/bash
# Verify ANTLR version references in project scripts
rg -n "ANTLR" -C2 Taskfile.yml
rg -n "ANTLR" -C2 tools/scripts/deps-download/init.sh

Length of output: 137


To locate the build/download scripts and verify their ANTLR references, let’s search the repo for Taskfile.* and init.sh, then scan them for “antlr” (case-insensitive):


🏁 Script executed:

#!/bin/bash
# 1. Find any Taskfile variants
find . -type f -iname 'Taskfile.*'

# 2. Find any init.sh scripts
find . -type f -iname 'init.sh'

# 3. If found, grep for ANTLR references (case-insensitive)
for file in $(find . -type f \( -iname 'Taskfile.*' -o -iname 'init.sh' \)); do
  echo "=== $file ==="
  rg -i "antlr" -C2 "$file" || echo "No ANTLR refs in $file"
done

# 4. Global search for ANTLR occurrences
echo "=== Global ANTLR search ==="
rg -i "antlr" -n .

Length of output: 31457


ANTLR Version Bump Verified
All dependency scripts now reference v4.13.2:

  • taskfiles/deps/main.yaml sets
    G_ANTLR_VERSION: "4.13.2"
    and constructs the download URLs for both the ANTLR jar and runtime.
  • taskfile.yaml invokes the jar via {{.G_ANTLR_JAR_FILE}}, which resolves to the updated 4.13.2 artifact.
  • tools/scripts/deps-download/init.sh contains no hard-coded ANTLR versions—and instead relies on the central deps workflow.

No further changes required.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@LinZhihao-723 LinZhihao-723 merged commit 8e1c32b into y-scope:main Jun 10, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants