Skip to content

docs(clp-core): Update CLP core dependency names and versions. - #1262

Merged
jackluo923 merged 1 commit into
y-scope:mainfrom
Bill-hbrhbr:fix-core-deps-versions
Aug 25, 2025
Merged

docs(clp-core): Update CLP core dependency names and versions.#1262
jackluo923 merged 1 commit into
y-scope:mainfrom
Bill-hbrhbr:fix-core-deps-versions

Conversation

@Bill-hbrhbr

@Bill-hbrhbr Bill-hbrhbr commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Description

Due to frequent updates, our documentation has gone slightly out of sync with what's being done in task deps:core. This PR fixes library names and updates versions.

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

  • Only documentation changes.

Summary by CodeRabbit

  • Documentation
    • Updated the Source Dependencies table to use versioned references instead of Git links.
    • Added Microsoft GSL and nlohmann_json to the listed dependencies.
    • Replaced legacy Git-based entries with their versioned counterparts and clarified versions across libraries.
    • Improved table formatting and ordering for readability.
    • No changes to application behaviour or runtime.

@Bill-hbrhbr
Bill-hbrhbr requested a review from a team as a code owner August 25, 2025 07:15
@coderabbitai

coderabbitai Bot commented Aug 25, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The documentation file docs/src/dev-guide/components-core/index.md was updated to replace Git-based dependency references with versioned/non-Git entries, add microsoft.gsl and nlohmann_json, map prior git-submodule entries to versions/commits, and reorder/reformat the Source Dependencies table. No code changes.

Changes

Cohort / File(s) Summary
Docs: Dependencies table update
docs/src/dev-guide/components-core/index.md
Replaced git-based dependencies with versioned/non-Git entries (e.g., Catch2 v3.8.0, date v3.0.1, nlohmann_json v3.11.3, utfcpp v4.0.6); added microsoft.gsl v4.0.0; mapped internal libs to specific commits; retained zlib/zstd; reformatted/reordered table.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • davidlion
  • anlowee
  • kirkrodrigues
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0f14077 and 0489494.

📒 Files selected for processing (1)
  • docs/src/dev-guide/components-core/index.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: lint-check (ubuntu-24.04)
  • GitHub Check: lint-check (macos-15)
🔇 Additional comments (3)
docs/src/dev-guide/components-core/index.md (3)

41-42: Good switch to versioned, tagged releases for Catch2 and date

Pinning Catch2 to v3.8.0 and Howard Hinnant’s date to v3.0.1 improves reproducibility and aligns with the move away from git-submodule pins.


54-55: Please manually verify utfcpp and yaml-cpp integration

Our automated scan didn’t detect any direct references in the codebase to either utfcpp headers or yaml-cpp linkage, so you’ll need to confirm these yourself:

• No utfcpp includes found
– Neither classic #include <utf8…> nor the v4 pattern #include <utfcpp/...> was detected.
– If you’re using utfcpp v4.0.6, ensure your code includes the correct headers (e.g. <utfcpp/utf8.h> or whichever path matches your install).

• No yaml-cpp linkage in CMake
– We didn’t see any target_link_libraries(... yaml-cpp) calls.
– Verify you’re linking against the proper target name (for v0.7.0 this may be yaml-cpp or yaml-cpp::yaml-cpp, depending on how you configured find_package) and that any required CMake policies (e.g., CMP0074 for find_package namespacing) are set.

Please review your project’s include paths and CMakeLists files (including any subdirectories or external modules) to make sure the documentation versions match your actual build setup.


45-45: Action required: replace short 7–8 char SHAs with durable pins
I attempted to verify the three prefixes via git ls-remote, but no matches were returned (likely due to network or access restrictions). Please manually confirm each SHA and update the table to use either a released tag or a ≥12-character commit ID (optionally appending the commit date for auditability).

Locations:

  • File: docs/src/dev-guide/components-core/index.md
    – Lines 45 & 56

Entries to update:

  • y-scope/log-surgeon @ a82ad13
  • y-scope/yscope-log-viewer @ 3abe4cc
  • y-scope/ystdlib-cpp @ d80cf86

Preferred pin formats:

  • A released, immutable tag (ideal), or
  • The full ≥12-char SHA (e.g., abcdef123456…) plus the commit date in brackets (e.g., [2024-09-12]).

Comment thread docs/src/dev-guide/components-core/index.md
Comment thread docs/src/dev-guide/components-core/index.md
@Bill-hbrhbr
Bill-hbrhbr requested a review from jackluo923 August 25, 2025 07:23
@Bill-hbrhbr Bill-hbrhbr changed the title Update docs and versions docs(clp-core): Update CLP core dependency names and versions. Aug 25, 2025
@jackluo923
jackluo923 merged commit 296dc0a into y-scope:main Aug 25, 2025
8 of 11 checks passed
junhaoliao pushed a commit to junhaoliao/clp that referenced this pull request May 17, 2026
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.

2 participants