Skip to content

Conversation

@Bill-hbrhbr
Copy link
Contributor

@Bill-hbrhbr Bill-hbrhbr commented Oct 23, 2025

  • Remove redundant checksum validation for antlr-jar.
  • Refactor antlr-runtime to build via utils:install-remote-cmake-lib.
  • Modify CMAKE_GEN_ARGS of each task to conform to the newly set rules.
  • Make spider platform check POSIX-compatible

Description

Due to various CMAKE_GEN_ARGS issues encountered while reviewing other PRs such as #1377 and #1414, we standardize CMake lib writing once and for all to cut down on future review/development time.

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

  • Dep tasks run successfully and help build functionally correct binaries.

Summary by CodeRabbit

Summary by CodeRabbit

Release Notes

  • Documentation

    • Added a new Dependency Taskfiles README with guidelines and best practices for writing and updating dependency installation taskfiles.
  • Chores

    • Standardized and simplified dependency installation tasks, consolidating build/install flows and aligning default build flags and packaging behaviours for multiple libraries.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 23, 2025

Walkthrough

Adds a dependency-taskfiles README and refactors taskfiles/deps/main.yaml to centralize dependency installation via install-remote-cmake-lib, inline tarball URLs/SHA256, standardize extraction naming, and normalize CMake generation arguments across many libraries.

Changes

Cohort / File(s) Summary
Documentation
taskfiles/deps/README.md
New guidelines for writing/updating dependency installation taskfiles: preferred install tasks, checksum guidance, extraction dir naming, and recommended CMake generation arguments and flags.
Centralized installer & per-lib updates
taskfiles/deps/main.yaml
Reworked dependency entries to use install-remote-cmake-lib with parameters (LIB_NAME, TARBALL_URL, TARBALL_SHA256, CMAKE_GEN_ARGS, CMAKE_SOURCE_DIR); inlined many tarball URLs/SHA256; removed numerous legacy public vars (e.g., VERSION, CHECKSUM_FILE, OUTPUT_FILE) and consolidated CMake flags and extraction naming conventions (e.g., -src-extracted).
Specific dependency adjustments
taskfiles/deps/main.yamlantlr-jar, antlr-runtime, boost, catch2, liblzma, log-surgeon, lz4, mariadb-connector-cpp, mongocxx, msgpack-cxx, nlohmann_json, simdjson, spdlog, sqlite3, utfcpp, yaml-cpp, ystdlib, zlib, zstd
Per-package changes include: removal of legacy public variables; fixed-versioned TARBALL_URLs; added/normalized CMAKE_GEN_ARGS (enable shared libs, disable tests/docs/examples, set CMAKE_BUILD_TYPE=Release, CMAKE_INSTALL_MESSAGE=LAZY, CMake policy flags where needed); extraction dir/name changes; and smaller formatting/script tweaks.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Developer
  participant TaskfileRunner as Taskfile runner
  participant Installer as install-remote-cmake-lib
  participant Remote as Tarball host
  participant Build as CMake/Build
  Note over TaskfileRunner,Installer #D6EAF8: New centralized flow per dependency
  Developer->>TaskfileRunner: invoke dependency task (per-lib)
  TaskfileRunner->>Installer: call with LIB_NAME, TARBALL_URL, TARBALL_SHA256, CMAKE_GEN_ARGS, CMAKE_SOURCE_DIR
  Installer->>Remote: fetch tarball (TARBALL_URL)
  alt checksum present
    Remote-->>Installer: tarball
    Installer->>Installer: verify SHA256
  else checksum removed/inlined
    Remote-->>Installer: tarball
  end
  Installer->>Installer: extract to <lib>-extracted
  Installer->>Build: cmake configure (CMAKE_GEN_ARGS)
  Build->>Build: build (shared/static per args)
  Build->>Installer: install artifacts
  Installer-->>TaskfileRunner: success/failure
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • Review focus areas:
    • Verify per-package CMAKE_GEN_ARGS correctness (flags and policy changes).
    • Confirm inlined TARBALL_URL/TARBALL_SHA256 values match intended releases.
    • Ensure extraction dir/name changes (-extracted) and any downstream consumers are updated.
    • Check removal of public variables doesn't break callers that reference them.

Possibly related issues

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "refactor(deps): Document standard rules for writing lib install tasks and apply across all existing tasks" directly and accurately describes the two main components of the changeset. The PR adds a comprehensive README documenting standardized guidelines for dependency installation taskfiles and simultaneously refactors all existing tasks in the main.yaml file to conform to these newly documented rules. The title is specific and clear, avoiding vague terminology, and it comprehensively captures the dual purpose of the change: establishing documentation standards and applying them systematically across the codebase. A developer scanning the commit history would immediately understand that this PR addresses standardization of library installation task writing practices.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 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 90bbe66 and 6c64a5b.

📒 Files selected for processing (2)
  • taskfiles/deps/README.md (1 hunks)
  • taskfiles/deps/main.yaml (15 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1122
File: components/core/src/clp/clp/CMakeLists.txt:175-195
Timestamp: 2025-07-23T09:54:45.185Z
Learning: In the CLP project, when reviewing CMakeLists.txt changes that introduce new compression library dependencies (BZip2, LibLZMA, LZ4, ZLIB), the team prefers to address conditional linking improvements in separate PRs rather than expanding the scope of focused migration PRs like the LibArchive task-based installation migration.
📚 Learning: 2025-05-28T18:33:30.155Z
Learnt from: anlowee
PR: y-scope/clp#925
File: taskfiles/deps/main.yaml:97-106
Timestamp: 2025-05-28T18:33:30.155Z
Learning: In the taskfiles dependency system (taskfiles/deps/main.yaml), echo commands are used to generate .cmake settings files that are consumed by the main CMake build process. These files set variables like ANTLR_RUNTIME_HEADER to point to dependency locations for use during compilation.

Applied to files:

  • taskfiles/deps/main.yaml
📚 Learning: 2025-09-15T18:53:15.844Z
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1226
File: taskfiles/deps/main.yaml:522-527
Timestamp: 2025-09-15T18:53:15.844Z
Learning: When ystdlib is built with -Dystdlib_BUILD_TESTING=OFF in taskfiles/deps/main.yaml, it does not require Catch2 settings to be injected via CMAKE_GEN_ARGS since testing is disabled and Catch2 is not needed during the build process.

Applied to files:

  • taskfiles/deps/main.yaml
📚 Learning: 2025-08-19T07:08:15.583Z
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1229
File: taskfiles/deps/main.yaml:494-504
Timestamp: 2025-08-19T07:08:15.583Z
Learning: In zlib v1.3.1's CMake build system, only ZLIB_BUILD_EXAMPLES is a valid option. Other ZLIB_BUILD_* flags (MINIZIP, SHARED, STATIC, TESTING) and ZLIB_INSTALL are not defined in the CMakeLists.txt and have no effect. Use BUILD_SHARED_LIBS=ON for shared library control and ZLIB_BUILD_EXAMPLES=OFF to disable examples.

Applied to files:

  • taskfiles/deps/main.yaml
🪛 LanguageTool
taskfiles/deps/README.md

[grammar] ~12-~12: A determiner may be missing.
Context: ...stallation includes checksum validation using best effort. - Use of yscope-dev-utils...

(THE_SUPERLATIVE)


[style] ~32-~32: Consider using a different verb to strengthen your wording.
Context: ...s, examples, docs or unused binaries to speed up the install process. - Prefer disablin...

(SPEED_UP_ACCELERATE)


[grammar] ~32-~32: The word ‘install’ is not a noun.
Context: ...docs or unused binaries to speed up the install process. - Prefer disabling lib-specif...

(A_INSTALL)

⏰ 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). (3)
  • GitHub Check: build-macos (macos-14, false)
  • GitHub Check: rust-checks (ubuntu-24.04)
  • GitHub Check: rust-checks (ubuntu-22.04)
🔇 Additional comments (4)
taskfiles/deps/main.yaml (2)

167-186: Refactor of antlr-runtime to centralized installer is sound.

The migration from per-component build sequences to utils:install-remote-cmake-lib with inlined tarball URLs/SHA256 and CMAKE_GEN_ARGS is well-structured. The addition of CMAKE_SOURCE_DIR: "runtime/Cpp" correctly targets the C++ runtime subdirectory, and the CMP0135 policy flag ensures consistent timestamp handling.


155-165: Checksum removal for antlr-jar is appropriate.

The redundant checksum validation step has been properly removed. The yscope-dev-utils:remote:curl task inherently includes checksum verification via the FILE_SHA256 parameter, eliminating the need for a separate validation step. This aligns with the PR's goal to standardize and streamline dependency installation.

taskfiles/deps/README.md (2)

5-11: Guideline hierarchy is clear and actionable.

The preference order for installation tasks (install-remote-cmake-lib first, then install-remote-tar, then special cases) is explicit and aligns with the centralized installer approach. The requirement to include utils:init in deps: for special tasks and to provide rationale is well-documented.


20-40: CMake Generate Arguments guidelines align with standardization goals.

The documented rules for CMAKE_GEN_ARGS—including CMP0074 handling, shared/static library building, test/doc/example skipping, and library-specific flags over generic BUILD_TESTING—are well-reasoned and provide concrete direction. The exceptions for CMAKE_BUILD_TYPE and CMAKE_INSTALL_MESSAGE are appropriately justified.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@Bill-hbrhbr
Copy link
Contributor Author

Bill-hbrhbr commented Oct 23, 2025

@coderabbitai

give me a diff of each lib install task in the current version against the files in PR #1377, diff should include comments as well.

@Bill-hbrhbr
Copy link
Contributor Author

@coderabbitai Diff should include the comments inside the tasks. not your own comments.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 23, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash

# First, let's see what lib install tasks are in the current PR
echo "=== Lib install task files in current PR ==="
gh pr view 1479 --json files --jq '.files[].path' | grep -E 'lib.*install.*\.ya?ml'

echo ""
echo "=== Looking for task files more broadly ==="
gh pr view 1479 --json files --jq '.files[].path' | grep -E '\.ya?ml$'

Length of output: 114


🏁 Script executed:

#!/bin/bash

# Let's also check the directory structure to understand where lib install tasks are
echo "=== Finding YAML files in components/core/tools/scripts/lib_install ==="
fd -e yml -e yaml . components/core/tools/scripts/lib_install 2>/dev/null || echo "Directory not found, searching more broadly..."

echo ""
echo "=== All YAML task files in the repo ==="
fd -e yml -e yaml . components/core/tools/scripts 2>/dev/null | head -20

Length of output: 278


🏁 Script executed:

#!/bin/bash

# Get the list of changed files in PR #1479
echo "=== All changed files in PR #1479 ==="
gh pr view 1479 --json files --jq '.files[] | .path'

Length of output: 62


🏁 Script executed:

#!/bin/bash

# Let's see what files were changed in PR #1377
echo "=== Files changed in PR #1377 ==="
gh pr view 1377 --json files --jq '.files[] | .path' | sort

echo ""
echo "=== Looking for lib install or taskfile changes in PR #1377 ==="
gh pr view 1377 --json files --jq '.files[] | .path' | grep -E '(taskfile|lib_install|deps)'

Length of output: 2174


🏁 Script executed:

#!/bin/bash

# Let's get the content of taskfiles/deps/main.yaml from the current PR #1479
echo "=== Current version in PR #1479 ==="
cat taskfiles/deps/main.yaml

Length of output: 20857


🏁 Script executed:

#!/bin/bash

# Let's fetch the version from PR #1377
# First, get the branch name or commit from PR #1377
echo "=== PR #1377 details ==="
gh pr view 1377 --json headRefName,number,title

echo ""
echo "=== Fetching taskfiles/deps/main.yaml from PR #1377 ==="
# Get the head ref of PR #1377
HEAD_REF=$(gh pr view 1377 --json headRefName --jq '.headRefName')
echo "Head ref: $HEAD_REF"

# Fetch the file from that branch
git fetch origin "$HEAD_REF:pr-1377-branch" 2>/dev/null || echo "Could not fetch branch"
git show "pr-1377-branch:taskfiles/deps/main.yaml" 2>/dev/null || echo "File not found in PR #1377"

Length of output: 388


🏁 Script executed:

#!/bin/bash

# Let's try fetching the file content directly using gh api
echo "=== Getting file content from PR #1377 ==="
gh api repos/y-scope/clp/pulls/1377/files --jq '.[] | select(.filename == "taskfiles/deps/main.yaml") | .raw_url' | head -1 | xargs -I {} curl -s {}

Length of output: 42


🏁 Script executed:

#!/bin/bash

# Now let's get all the install task files from PR #1377
echo "=== Getting all install task files from PR #1377 ==="
gh api repos/y-scope/clp/pulls/1377/files --jq '.[] | select(.filename | contains("taskfiles/deps/installs/")) | .filename'

Length of output: 956


🏁 Script executed:

#!/bin/bash

# Get the content of all install task files from current PR
echo "=== Checking if install tasks directory exists in current PR ==="
ls -la taskfiles/deps/installs/ 2>/dev/null || echo "Directory does not exist in current PR"

echo ""
echo "=== Checking directory structure ==="
find taskfiles/deps -type f -name "*.yaml" 2>/dev/null

Length of output: 217


🏁 Script executed:

#!/bin/bash

# Get raw URLs for all install task files from PR #1377
echo "=== Fetching raw URLs for install tasks from PR #1377 ==="
gh api repos/y-scope/clp/pulls/1377/files --jq '.[] | select(.filename | contains("taskfiles/deps/installs/")) | "\(.filename) \(.raw_url)"'

Length of output: 3833


🏁 Script executed:

#!/bin/bash

# Extract individual lib install tasks from current main.yaml and create temp files for diffing
# Let's use awk to extract each task

# List of lib install tasks to extract
LIBS="absl antlr-jar antlr-runtime boost catch2 date fmt liblzma liblzma-install log-surgeon lz4 mariadb-connector-cpp microsoft.gsl mongocxx msgpack-cxx nlohmann_json simdjson spdlog sqlite3 utfcpp yaml-cpp ystdlib zlib zstd"

mkdir -p /tmp/current-tasks

for lib in $LIBS; do
  echo "Extracting task: $lib"
  awk -v lib="$lib" '
    BEGIN { in_task = 0; indent = "" }
    /^[[:space:]]*'"$lib"':/ && !/'"$lib"'-/ { 
      in_task = 1
      print
      # Get the indent level
      match($0, /^[[:space:]]*/)
      indent = substr($0, RSTART, RLENGTH)
      next
    }
    in_task {
      # Check if we hit another task at the same level
      if (/^[[:space:]]*[a-zA-Z0-9_-]+:/ && match($0, /^[[:space:]]*/)) {
        current_indent = substr($0, RSTART, RLENGTH)
        if (length(current_indent) <= length(indent)) {
          exit
        }
      }
      print
    }
  ' taskfiles/deps/main.yaml > /tmp/current-tasks/${lib}.yaml
done

echo "Tasks extracted to /tmp/current-tasks/"
ls -la /tmp/current-tasks/

Length of output: 2294


🏁 Script executed:

#!/bin/bash

# Download all install task files from PR #1377
mkdir -p /tmp/pr-1377-tasks

echo "=== Downloading install task files from PR #1377 ==="

# Download each file
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fabsl.yaml" > /tmp/pr-1377-tasks/absl.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fantlr-jar.yaml" > /tmp/pr-1377-tasks/antlr-jar.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fantlr-runtime.yaml" > /tmp/pr-1377-tasks/antlr-runtime.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fboost.yaml" > /tmp/pr-1377-tasks/boost.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fcatch2.yaml" > /tmp/pr-1377-tasks/catch2.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fdate.yaml" > /tmp/pr-1377-tasks/date.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Ffmt.yaml" > /tmp/pr-1377-tasks/fmt.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fliblzma.yaml" > /tmp/pr-1377-tasks/liblzma.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Flog-surgeon.yaml" > /tmp/pr-1377-tasks/log-surgeon.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Flz4.yaml" > /tmp/pr-1377-tasks/lz4.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fmariadb-connector-cpp.yaml" > /tmp/pr-1377-tasks/mariadb-connector-cpp.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fmicrosoft.gsl.yaml" > /tmp/pr-1377-tasks/microsoft.gsl.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fmongocxx.yaml" > /tmp/pr-1377-tasks/mongocxx.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fmsgpack-cxx.yaml" > /tmp/pr-1377-tasks/msgpack-cxx.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fnlohmann_json.yaml" > /tmp/pr-1377-tasks/nlohmann_json.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fsimdjson.yaml" > /tmp/pr-1377-tasks/simdjson.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fspdlog.yaml" > /tmp/pr-1377-tasks/spdlog.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fsqlite3.yaml" > /tmp/pr-1377-tasks/sqlite3.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Futfcpp.yaml" > /tmp/pr-1377-tasks/utfcpp.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fyaml-cpp.yaml" > /tmp/pr-1377-tasks/yaml-cpp.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fystdlib.yaml" > /tmp/pr-1377-tasks/ystdlib.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fzlib.yaml" > /tmp/pr-1377-tasks/zlib.yaml
curl -s "https://github.com/y-scope/clp/raw/a143bda8fd871a47d05af81b545319c0dc8fc2b9/taskfiles%2Fdeps%2Finstalls%2Fzstd.yaml" > /tmp/pr-1377-tasks/zstd.yaml

echo "Files downloaded"
ls -la /tmp/pr-1377-tasks/

Length of output: 1601


🏁 Script executed:

#!/bin/bash

# Now generate diffs for each lib install task
echo "=== Generating diffs for each lib install task ==="
echo ""

LIBS="absl antlr-jar antlr-runtime boost catch2 date fmt liblzma log-surgeon lz4 mariadb-connector-cpp microsoft.gsl mongocxx msgpack-cxx nlohmann_json simdjson spdlog sqlite3 utfcpp yaml-cpp ystdlib zlib zstd"

for lib in $LIBS; do
  echo "=========================================="
  echo "DIFF for: $lib"
  echo "=========================================="
  
  if [ -f "/tmp/pr-1377-tasks/${lib}.yaml" ] && [ -s "/tmp/current-tasks/${lib}.yaml" ]; then
    diff -u "/tmp/pr-1377-tasks/${lib}.yaml" "/tmp/current-tasks/${lib}.yaml" || true
  else
    if [ ! -f "/tmp/pr-1377-tasks/${lib}.yaml" ]; then
      echo "File not found in PR #1377"
    fi
    if [ ! -s "/tmp/current-tasks/${lib}.yaml" ]; then
      echo "File empty or not found in current PR"
    fi
  fi
  echo ""
  echo ""
done

Length of output: 20921


🏁 Script executed:

#!/bin/bash

# The URLs were not working, let's try using gh api to get the raw content
echo "=== Fetching content from PR #1377 using gh api ==="

# Let's try to get the files using gh api with proper decoding
mkdir -p /tmp/pr-1377-tasks-v2

# List of libraries
LIBS="absl antlr-jar antlr-runtime boost catch2 date fmt liblzma log-surgeon lz4 mariadb-connector-cpp microsoft.gsl mongocxx msgpack-cxx nlohmann_json simdjson spdlog sqlite3 utfcpp yaml-cpp ystdlib zlib zstd"

# Get the commit SHA for PR #1377
COMMIT_SHA="a143bda8fd871a47d05af81b545319c0dc8fc2b9"

for lib in $LIBS; do
  echo "Fetching $lib.yaml..."
  gh api -H "Accept: application/vnd.github.v3.raw" \
    "/repos/y-scope/clp/contents/taskfiles/deps/installs/${lib}.yaml?ref=${COMMIT_SHA}" \
    > /tmp/pr-1377-tasks-v2/${lib}.yaml 2>/dev/null || echo "Failed to fetch ${lib}.yaml"
done

echo ""
echo "Files downloaded:"
ls -lh /tmp/pr-1377-tasks-v2/

Length of output: 2121


🏁 Script executed:

#!/bin/bash

# Now generate clean diffs for each lib install task
echo "Generating diffs between PR #1377 and current PR #1479"
echo "Format: --- PR #1377 version, +++ Current PR #1479 version"
echo ""

LIBS="absl antlr-jar antlr-runtime boost catch2 date fmt liblzma log-surgeon lz4 mariadb-connector-cpp microsoft.gsl mongocxx msgpack-cxx nlohmann_json simdjson spdlog sqlite3 utfcpp yaml-cpp ystdlib zlib zstd"

for lib in $LIBS; do
  echo "=========================================="
  echo "DIFF: $lib"
  echo "=========================================="
  
  if [ -f "/tmp/pr-1377-tasks-v2/${lib}.yaml" ] && [ -s "/tmp/current-tasks/${lib}.yaml" ]; then
    diff -u "/tmp/pr-1377-tasks-v2/${lib}.yaml" "/tmp/current-tasks/${lib}.yaml" || true
  else
    if [ ! -f "/tmp/pr-1377-tasks-v2/${lib}.yaml" ]; then
      echo "ERROR: File not found in PR #1377"
    fi
    if [ ! -s "/tmp/current-tasks/${lib}.yaml" ]; then
      echo "ERROR: File empty or not found in current PR"
    fi
  fi
  echo ""
done

echo "=========================================="
echo "SPECIAL CASE: liblzma-install"
echo "=========================================="
echo "NOTE: liblzma-install is an internal task in current PR but not a separate file in PR #1377"
cat /tmp/current-tasks/liblzma-install.yaml
echo ""

Length of output: 23007


@Bill-hbrhbr: Here are the diffs for each lib install task between PR #1377 and current PR #1479, with all comments inside the tasks preserved:

The key structural differences across all tasks:

PR #1377 structure (separate files):

version: "3"

tasks:
  default:
    # task content

Current PR #1479 structure (inline in main.yaml):

  task-name:
    # task content

Main changes:

  1. Task references: :taskutils:task or yscope-dev-utils:task
  2. Variables: Template variables like {{.VERSION}} → hardcoded values
  3. Dependencies: for loops → direct task dependencies
  4. Missing CMAKE flags: Some tasks added -DCMAKE_BUILD_TYPE=Release and -DCMAKE_INSTALL_MESSAGE=LAZY (e.g., ystdlib)

Special cases:

All 23 complete lib install tasks have been compared with their full content including comments preserved in the diffs above.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 23, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash

# Get the list of files changed in PR #1479 (current PR)
echo "=== Files in PR #1479 ==="
gh pr view 1479 --json files --jq '.files[].path' | sort

echo ""
echo "=== Files in PR #1377 ==="
# Get the list of files changed in PR #1377
gh pr view 1377 --json files --jq '.files[].path' | sort

echo ""
echo "=== PR #1377 details ==="
gh pr view 1377 --json number,title,state,mergedAt,headRefName

Length of output: 1397


🏁 Script executed:

#!/bin/bash

# Get the branch name for PR #1377 to checkout its files
PR_1377_BRANCH=$(gh pr view 1377 --json headRefName --jq '.headRefName')
echo "PR #1377 branch: $PR_1377_BRANCH"

# Fetch the branch
git fetch origin "$PR_1377_BRANCH"

# List lib install task files in the current branch (PR #1479)
echo ""
echo "=== Lib install task files in current PR (1479) ==="
fd -t f -e yml -e yaml . tasks | grep -i 'lib.*install' | sort

echo ""
echo "=== All yml files in tasks directory (current branch) ==="
fd -t f -e yml -e yaml . tasks | sort

Length of output: 390


🏁 Script executed:

#!/bin/bash

# Let's find what files exist in tasks directory on the current branch
echo "=== Current branch task files ==="
find tasks -name "*.yml" -o -name "*.yaml" 2>/dev/null | sort

# Get PR #1377 branch name
PR_1377_BRANCH=$(gh pr view 1377 --json headRefName --jq '.headRefName')

# Checkout PR #1377 branch files to a temporary location
git fetch origin "$PR_1377_BRANCH"

echo ""
echo "=== Task files in PR #1377 branch ==="
git ls-tree -r --name-only "origin/$PR_1377_BRANCH" tasks/ | grep -E '\.(yml|yaml)$' | sort

Length of output: 186


🏁 Script executed:

#!/bin/bash

# Get the exact list of lib install task files from current branch
echo "=== Identifying lib install task files ==="

# Find all yml/yaml files in tasks directory
CURRENT_TASKS=$(find tasks -type f \( -name "*.yml" -o -name "*.yaml" \) 2>/dev/null | sort)

echo "Current task files:"
echo "$CURRENT_TASKS"

# Get PR #1377 branch
PR_1377_BRANCH=$(gh pr view 1377 --json headRefName --jq '.headRefName')
git fetch origin "$PR_1377_BRANCH" 2>/dev/null

echo ""
echo "=== Files from PR #1377 ==="
git ls-tree -r --name-only "origin/$PR_1377_BRANCH" tasks/ 2>/dev/null | grep -E '\.(yml|yaml)$' | sort

Length of output: 92


🏁 Script executed:

#!/bin/bash

# Let's be more specific and get lib install task files
# First, let's see what files are in the tasks directory

echo "=== Current branch lib install tasks ==="
fd -t f 'lib.*install.*\.yml' tasks 2>/dev/null || find tasks -type f -name "*lib*install*.yml" 2>/dev/null

echo ""
echo "=== All current tasks files ==="
find tasks -type f -name "*.yml" | head -20

# Get PR branch
PR_1377_BRANCH=$(gh pr view 1377 --json headRefName --jq '.headRefName')
echo ""
echo "PR #1377 branch: $PR_1377_BRANCH"

# Show files that exist in PR #1377
echo ""
echo "=== Checking out PR #1377 files ==="
git fetch origin "$PR_1377_BRANCH"
git show "origin/$PR_1377_BRANCH":tasks/ 2>/dev/null | head -20 || echo "Directory listing not available"

# List files in tasks from PR #1377
git ls-tree -r --name-only "origin/$PR_1377_BRANCH" -- tasks/ | head -20

Length of output: 305


🏁 Script executed:

#!/bin/bash

# Check the actual directory structure
echo "=== Repository structure ==="
ls -la

echo ""
echo "=== Looking for taskfiles directory ==="
ls -la taskfiles/ 2>/dev/null || echo "taskfiles directory not found"

echo ""
echo "=== Files in taskfiles/deps/ ==="
find taskfiles/deps -type f -name "*.yaml" 2>/dev/null | sort

echo ""
echo "=== Files in taskfiles/deps/installs/ ==="
find taskfiles/deps/installs -type f -name "*.yaml" 2>/dev/null | sort

Length of output: 2128


🏁 Script executed:

#!/bin/bash

# Get file contents from PR #1377 using GitHub API
# First, let's check if we can fetch commits from the PR

echo "=== Getting PR #1377 commit SHA ==="
PR_1377_SHA=$(gh pr view 1377 --json commits --jq '.commits[-1].oid')
echo "Latest commit SHA in PR #1377: $PR_1377_SHA"

# Try fetching that specific commit
git fetch origin "$PR_1377_SHA" 2>&1 || echo "Could not fetch commit"

# List files at that commit
echo ""
echo "=== Files in PR #1377 ==="
git ls-tree -r --name-only "$PR_1377_SHA" -- taskfiles/deps/installs/ 2>/dev/null | sort

Length of output: 1150


🏁 Script executed:

#!/bin/bash

# Alternative approach: Download file contents directly from PR #1377 using GitHub API
# Get the list of install task files from PR #1377

echo "=== Install task files from PR #1377 ==="
INSTALL_FILES=(
  "taskfiles/deps/installs/absl.yaml"
  "taskfiles/deps/installs/antlr-jar.yaml"
  "taskfiles/deps/installs/antlr-runtime.yaml"
  "taskfiles/deps/installs/boost.yaml"
  "taskfiles/deps/installs/catch2.yaml"
  "taskfiles/deps/installs/date.yaml"
  "taskfiles/deps/installs/fmt.yaml"
  "taskfiles/deps/installs/liblzma.yaml"
  "taskfiles/deps/installs/log-surgeon.yaml"
  "taskfiles/deps/installs/lz4.yaml"
  "taskfiles/deps/installs/mariadb-connector-cpp.yaml"
  "taskfiles/deps/installs/microsoft.gsl.yaml"
  "taskfiles/deps/installs/mongocxx.yaml"
  "taskfiles/deps/installs/msgpack-cxx.yaml"
  "taskfiles/deps/installs/nlohmann_json.yaml"
  "taskfiles/deps/installs/simdjson.yaml"
  "taskfiles/deps/installs/spdlog.yaml"
  "taskfiles/deps/installs/sqlite3.yaml"
  "taskfiles/deps/installs/utfcpp.yaml"
  "taskfiles/deps/installs/yaml-cpp.yaml"
  "taskfiles/deps/installs/ystdlib.yaml"
  "taskfiles/deps/installs/zlib.yaml"
  "taskfiles/deps/installs/zstd.yaml"
)

# Get the commit SHA from PR #1377
PR_1377_SHA=$(gh pr view 1377 --json commits --jq '.commits[-1].oid')
echo "PR #1377 latest commit: $PR_1377_SHA"

# Fetch the commit
git fetch origin "$PR_1377_SHA"

# Create a directory to store PR #1377 files
mkdir -p /tmp/pr_1377_files/taskfiles/deps/installs

# Extract files from the commit
for file in "${INSTALL_FILES[@]}"; do
  filename=$(basename "$file")
  echo "Extracting $file..."
  git show "$PR_1377_SHA:$file" > "/tmp/pr_1377_files/$file" 2>/dev/null && echo "  ✓ Extracted" || echo "  ✗ Not found"
done

echo ""
echo "=== Files extracted ==="
ls -la /tmp/pr_1377_files/taskfiles/deps/installs/

Length of output: 3315


🏁 Script executed:

#!/bin/bash

# Now let's check what files exist in the current branch
echo "=== Current branch install task files ==="
if [ -d "taskfiles/deps/installs" ]; then
  ls -la taskfiles/deps/installs/
else
  echo "Directory taskfiles/deps/installs does not exist in current branch"
fi

# Check if individual files exist
echo ""
echo "=== Checking individual install files in current branch ==="
INSTALL_FILES=(
  "taskfiles/deps/installs/absl.yaml"
  "taskfiles/deps/installs/antlr-jar.yaml"
  "taskfiles/deps/installs/antlr-runtime.yaml"
  "taskfiles/deps/installs/boost.yaml"
  "taskfiles/deps/installs/catch2.yaml"
  "taskfiles/deps/installs/date.yaml"
  "taskfiles/deps/installs/fmt.yaml"
  "taskfiles/deps/installs/liblzma.yaml"
  "taskfiles/deps/installs/log-surgeon.yaml"
  "taskfiles/deps/installs/lz4.yaml"
  "taskfiles/deps/installs/mariadb-connector-cpp.yaml"
  "taskfiles/deps/installs/microsoft.gsl.yaml"
  "taskfiles/deps/installs/mongocxx.yaml"
  "taskfiles/deps/installs/msgpack-cxx.yaml"
  "taskfiles/deps/installs/nlohmann_json.yaml"
  "taskfiles/deps/installs/simdjson.yaml"
  "taskfiles/deps/installs/spdlog.yaml"
  "taskfiles/deps/installs/sqlite3.yaml"
  "taskfiles/deps/installs/utfcpp.yaml"
  "taskfiles/deps/installs/yaml-cpp.yaml"
  "taskfiles/deps/installs/ystdlib.yaml"
  "taskfiles/deps/installs/zlib.yaml"
  "taskfiles/deps/installs/zstd.yaml"
)

for file in "${INSTALL_FILES[@]}"; do
  if [ -f "$file" ]; then
    echo "✓ $file exists"
  else
    echo "✗ $file does not exist"
  fi
done

Length of output: 1431


🏁 Script executed:

#!/bin/bash

# Let's look at the current main.yaml to see where the lib install tasks are defined
echo "=== Current taskfiles/deps/main.yaml content ==="
cat taskfiles/deps/main.yaml

echo ""
echo "=== Length of main.yaml ==="
wc -l taskfiles/deps/main.yaml

Length of output: 20928


🏁 Script executed:

#!/bin/bash

# Get main.yaml from PR #1377 to compare
PR_1377_SHA="a143bda8fd871a47d05af81b545319c0dc8fc2b9"

echo "=== PR #1377 main.yaml content ==="
git show "$PR_1377_SHA:taskfiles/deps/main.yaml" > /tmp/pr_1377_main.yaml
cat /tmp/pr_1377_main.yaml

echo ""
echo "=== Length of PR #1377 main.yaml ==="
wc -l /tmp/pr_1377_main.yaml

Length of output: 1386


🏁 Script executed:

#!/bin/bash

# Now let's analyze the current main.yaml to extract individual lib install tasks
# We'll need to identify each task block and its boundaries

echo "=== Extracting lib install task names from current main.yaml ==="
# Look for task definitions (lines starting with spaces followed by task name)
grep -E '^\s+[a-z0-9_-]+:$' taskfiles/deps/main.yaml | head -30

echo ""
echo "=== Sample of main.yaml structure ==="
head -100 taskfiles/deps/main.yaml

Length of output: 3492


🏁 Script executed:

#!/bin/bash

# Let's get a better understanding by looking at the structure
# Extract task names that match library names

PR_1377_SHA="a143bda8fd871a47d05af81b545319c0dc8fc2b9"

echo "=== Library install tasks in PR #1377 individual files ==="
ls -1 /tmp/pr_1377_files/taskfiles/deps/installs/*.yaml | while read file; do
  basename "$file" .yaml
done | sort

echo ""
echo "=== Searching for corresponding tasks in current main.yaml ==="
# The task names in main.yaml might be like "install-absl", "install-boost", etc.
grep -E '^\s+(install-|deps:install-)' taskfiles/deps/main.yaml | head -30

Length of output: 326


🏁 Script executed:

#!/bin/bash

# Let's extract each install task from current main.yaml
# First, let's understand the structure better

echo "=== Searching for install tasks in current main.yaml ==="
cat taskfiles/deps/main.yaml | grep -n "install-" | head -40

echo ""
echo "=== First 200 lines of current main.yaml ==="
head -200 taskfiles/deps/main.yaml

Length of output: 7819


🏁 Script executed:

#!/bin/bash

# Extract each library install task from current main.yaml and generate diffs
# We'll use Python to parse and extract each task properly

cat > /tmp/generate_diffs.py << 'PYTHON_SCRIPT'
import re
import subprocess

# Library names to extract
libs = [
    "absl", "antlr-jar", "antlr-runtime", "boost", "catch2", "date", "fmt",
    "liblzma", "log-surgeon", "lz4", "mariadb-connector-cpp", "microsoft.gsl",
    "mongocxx", "msgpack-cxx", "nlohmann_json", "simdjson", "spdlog", "sqlite3",
    "utfcpp", "yaml-cpp", "ystdlib", "zlib", "zstd"
]

# Read the current main.yaml
with open('taskfiles/deps/main.yaml', 'r') as f:
    main_yaml_lines = f.readlines()

# Function to extract a task from main.yaml
def extract_task(task_name, lines):
    """Extract a task block from the YAML lines."""
    task_lines = []
    in_task = False
    task_indent = None
    
    for i, line in enumerate(lines):
        # Check if this is the start of our task
        if re.match(r'^  ' + re.escape(task_name) + r':$', line):
            in_task = True
            task_indent = len(line) - len(line.lstrip())
            task_lines.append(line)
            continue
        
        if in_task:
            # Check if we've reached the next task at the same level
            if line.strip() and not line.startswith(' ' * (task_indent + 1)):
                # This is a new task at the same or higher level
                if re.match(r'^  [a-z0-9_-]+:$', line):
                    break
            task_lines.append(line)
    
    return ''.join(task_lines)

# Extract and create temp files for diffs
for lib in libs:
    current_task = extract_task(lib, main_yaml_lines)
    
    # Handle special cases with sub-tasks
    if lib == "liblzma":
        # Also extract liblzma-install task
        liblzma_install = extract_task("liblzma-install", main_yaml_lines)
        current_task += liblzma_install
    
    # Write current version to temp file
    current_file = f'/tmp/current_{lib}.yaml'
    with open(current_file, 'w') as f:
        f.write(current_task)
    
    # PR #1377 file path
    pr_1377_file = f'/tmp/pr_1377_files/taskfiles/deps/installs/{lib}.yaml'
    
    print(f"\n{'='*80}")
    print(f"DIFF: {lib}.yaml")
    print(f"Current (PR #1479) vs PR #1377")
    print(f"{'='*80}\n")
    
    # Generate diff
    result = subprocess.run(
        ['diff', '-u', pr_1377_file, current_file],
        capture_output=True,
        text=True
    )
    
    if result.returncode == 0:
        print(f"No differences found for {lib}.yaml")
    else:
        print(result.stdout)

PYTHON_SCRIPT

python /tmp/generate_diffs.py

Length of output: 24656


@Bill-hbrhbr Here are the diffs for each lib install task comparing the current version in PR #1479 against PR #1377:

Summary of Key Differences

The diffs reveal the structural changes between the two approaches:

PR #1377 (Modular Approach)

  • Each library has its own separate YAML file in taskfiles/deps/installs/
  • Each file has version: "3" declaration
  • Uses default: as the task name (standard for included taskfiles)
  • Task references use : prefix to reference parent namespace (e.g., :utils:install-remote-cmake-lib)
  • Some tasks use for loops for dependencies (log-surgeon, msgpack-cxx, spdlog, ystdlib)
  • Some use variables for versions (boost, mongocxx, msgpack-cxx)

Current PR #1479 (Monolithic Approach)

  • All library tasks embedded directly in taskfiles/deps/main.yaml
  • Task names match library names (e.g., absl:, boost:)
  • Task references are relative (e.g., utils:install-remote-cmake-lib)
  • Dependencies are listed explicitly rather than using for loops
  • Versions are hardcoded in URLs rather than using variables
  • Additional CMAKE_GEN_ARGS in ystdlib task (-DCMAKE_BUILD_TYPE=Release, -DCMAKE_INSTALL_MESSAGE=LAZY)

Notable Content Differences

  1. ystdlib: Current version includes additional CMAKE arguments
  2. liblzma: Slightly different YAML formatting for TARBALL_URL (folded string vs. literal)
  3. boost, mongocxx, msgpack-cxx: PR refactor(taskfile): Split main dependency Taskfile into category-specific modules; Migrate antlr-runtime and utfcpp to use utils:install-remote-cmake-lib. #1377 uses version variables, current has hardcoded versions

All 23 library install task diffs are shown in the output above. The main difference is the organizational structure, with PR #1377 splitting each library into its own file following a standard pattern, while the current PR keeps them all in main.yaml.

@Bill-hbrhbr Bill-hbrhbr changed the title chore(deps): Define standard rules for writing lib install tasks and apply across all existing tasks. chore(deps): Document standard rules for writing lib install tasks and apply across all existing tasks. Oct 23, 2025
@Bill-hbrhbr Bill-hbrhbr changed the title chore(deps): Document standard rules for writing lib install tasks and apply across all existing tasks. refactor(deps): Document standard rules for writing lib install tasks and apply across all existing tasks. Oct 23, 2025
@Bill-hbrhbr Bill-hbrhbr changed the title refactor(deps): Document standard rules for writing lib install tasks and apply across all existing tasks. refactor(deps): Document standard rules for writing lib install tasks and apply across all existing tasks: Oct 23, 2025
@Bill-hbrhbr Bill-hbrhbr marked this pull request as ready for review October 23, 2025 16:31
@Bill-hbrhbr Bill-hbrhbr requested a review from a team as a code owner October 23, 2025 16:31
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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9ff731b and 90bbe66.

📒 Files selected for processing (2)
  • taskfiles/deps/README.md (1 hunks)
  • taskfiles/deps/main.yaml (14 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1122
File: components/core/src/clp/clp/CMakeLists.txt:175-195
Timestamp: 2025-07-23T09:54:45.185Z
Learning: In the CLP project, when reviewing CMakeLists.txt changes that introduce new compression library dependencies (BZip2, LibLZMA, LZ4, ZLIB), the team prefers to address conditional linking improvements in separate PRs rather than expanding the scope of focused migration PRs like the LibArchive task-based installation migration.
📚 Learning: 2025-05-28T18:33:30.155Z
Learnt from: anlowee
PR: y-scope/clp#925
File: taskfiles/deps/main.yaml:97-106
Timestamp: 2025-05-28T18:33:30.155Z
Learning: In the taskfiles dependency system (taskfiles/deps/main.yaml), echo commands are used to generate .cmake settings files that are consumed by the main CMake build process. These files set variables like ANTLR_RUNTIME_HEADER to point to dependency locations for use during compilation.

Applied to files:

  • taskfiles/deps/main.yaml
📚 Learning: 2025-09-15T18:53:15.844Z
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1226
File: taskfiles/deps/main.yaml:522-527
Timestamp: 2025-09-15T18:53:15.844Z
Learning: When ystdlib is built with -Dystdlib_BUILD_TESTING=OFF in taskfiles/deps/main.yaml, it does not require Catch2 settings to be injected via CMAKE_GEN_ARGS since testing is disabled and Catch2 is not needed during the build process.

Applied to files:

  • taskfiles/deps/main.yaml
📚 Learning: 2025-08-19T07:08:15.583Z
Learnt from: Bill-hbrhbr
PR: y-scope/clp#1229
File: taskfiles/deps/main.yaml:494-504
Timestamp: 2025-08-19T07:08:15.583Z
Learning: In zlib v1.3.1's CMake build system, only ZLIB_BUILD_EXAMPLES is a valid option. Other ZLIB_BUILD_* flags (MINIZIP, SHARED, STATIC, TESTING) and ZLIB_INSTALL are not defined in the CMakeLists.txt and have no effect. Use BUILD_SHARED_LIBS=ON for shared library control and ZLIB_BUILD_EXAMPLES=OFF to disable examples.

Applied to files:

  • taskfiles/deps/main.yaml
🪛 LanguageTool
taskfiles/deps/README.md

[uncategorized] ~14-~14: Possible missing comma found.
Context: ...d parsing version numbers from download URLs unless the version is used elsewhere. ...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~30-~30: Consider using a different verb to strengthen your wording.
Context: ...s, examples, docs or unused binaries to speed up the install process. - Prefer disablin...

(SPEED_UP_ACCELERATE)


[grammar] ~30-~30: The word ‘install’ is not a noun.
Context: ...docs or unused binaries to speed up the install process. - Prefer disabling lib-specif...

(A_INSTALL)

🪛 markdownlint-cli2 (0.18.1)
taskfiles/deps/README.md

37-37: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


38-38: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

🔇 Additional comments (6)
taskfiles/deps/main.yaml (6)

155-186: LGTM: antlr-jar and antlr-runtime refactoring is clean.

The antlr-jar task correctly references the global G_ANTLR_JAR_FILE variable, and the antlr-runtime task is properly refactored to use install-remote-cmake-lib with appropriate CMake flags. The CMP0135 policy and comment explaining its purpose are well preserved.


296-313: Verify whether log-surgeon needs CMP0074=NEW policy.

The task uses -C {{.G_DEPS_CPP_CMAKE_SETTINGS_DIR}}/{{.G_FMT_LIB_NAME}}.cmake and {{.G_GSL_LIB_NAME}}.cmake config files for dependencies, which may internally use <PackageName>_ROOT variables. Per the README, CMP0074 should be set to NEW when the component depends on another via <lib_name>_ROOT. Compare this to msgpack-cxx (line 401) and spdlog (line 454), which both set CMAKE_POLICY_DEFAULT_CMP0074=NEW when using similar config files.

Does log-surgeon's CMakeLists.txt use find_package(fmt) and find_package(Microsoft.GSL) that would benefit from CMP0074? If so, add:

  CMAKE_GEN_ARGS:
    - "-C {{.G_DEPS_CPP_CMAKE_SETTINGS_DIR}}/{{.G_FMT_LIB_NAME}}.cmake"
    - "-C {{.G_DEPS_CPP_CMAKE_SETTINGS_DIR}}/{{.G_GSL_LIB_NAME}}.cmake"
+   - "-DCMAKE_POLICY_DEFAULT_CMP0074=NEW"
    - "-DCMAKE_BUILD_TYPE=Release"

530-546: Verify whether ystdlib needs CMP0074=NEW policy.

The task uses -C {{.G_DEPS_CPP_CMAKE_SETTINGS_DIR}}/{{.G_BOOST_LIB_NAME}}.cmake to load Boost configuration, which is the same pattern as msgpack-cxx (line 401) and spdlog (line 454). Both of those tasks explicitly set CMAKE_POLICY_DEFAULT_CMP0074=NEW, but ystdlib does not.

Confirm whether ystdlib's CMakeLists.txt uses find_package(Boost) in a way that would benefit from CMP0074. If so, add it to CMAKE_GEN_ARGS:

  CMAKE_GEN_ARGS:
    - "-C {{.G_DEPS_CPP_CMAKE_SETTINGS_DIR}}/{{.G_BOOST_LIB_NAME}}.cmake"
+   - "-DCMAKE_POLICY_DEFAULT_CMP0074=NEW"
    - "-DCMAKE_BUILD_TYPE=Release"

465-514: LGTM: sqlite3 and utfcpp follow new naming conventions.

Both tasks correctly use the -extracted directory suffix as per README guidance. The direct CMake config file generation via heredoc is appropriate for these special cases that don't use standard CMake install paths.


548-564: LGTM: zlib CMake arguments are correct.

Uses only valid zlib v1.3.1 configuration options (specifically ZLIB_BUILD_EXAMPLES=OFF rather than invalid ZLIB_BUILD_* variants). The special CMAKE_INSTALL_PREFIX handling is appropriate for zlib's structure.


241-256: Verify whether fmt should build both shared and static libraries.

Per the README, tasks should "build both shared and static libraries when possible." The fmt task (line 248) only sets BUILD_SHARED_LIBS=ON. Verify whether fmt's CMake supports static library builds and whether both variants are needed by downstream consumers.

If fmt supports and should build static libraries, add a corresponding flag or consider a pattern similar to liblzma (which invokes the task twice with different BUILD_SHARED_LIBS values).

Copy link
Contributor

@sitaowang1998 sitaowang1998 left a comment

Choose a reason for hiding this comment

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

The code lgtm. The doc needs some more works.

Copy link
Contributor

@sitaowang1998 sitaowang1998 left a comment

Choose a reason for hiding this comment

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

LGTM. This PR just makes me think that we need some documents in yscope-dev-utils to explain how to use the tasks. Some logic, e.g. checksum validation should be in task dependency, is hard to understand at first glance. Do you think it worth the effort @kirkrodrigues ?

@Bill-hbrhbr
Copy link
Contributor Author

Bill-hbrhbr commented Oct 28, 2025

LGTM. This PR just makes me think that we need some documents in yscope-dev-utils to explain how to use the tasks. Some logic, e.g. checksum validation should be in task dependency, is hard to understand at first glance. Do you think it worth the effort @kirkrodrigues ?

@davidlion In the near future, we could add some simple docs on how-to-use the checksum stuff.

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