build(taskfiles): Update to latest version of yscope-dev-utils; Replace cmake operations with cmake tasks; Add clean-core task.#734
Conversation
WalkthroughThis pull request implements updates to task definitions and naming conventions across various YAML configuration files. It introduces a new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant TaskRunner
participant CMakeUtils
User->>TaskRunner: Initiate core build
TaskRunner->>CMakeUtils: Generate build files (utils:cmake:generate)
TaskRunner->>CMakeUtils: Build core component (utils:cmake:build)
User->>TaskRunner: Trigger core clean-up (clean-core)
TaskRunner->>CMakeUtils: Clean build directory (utils:cmake:clean)
sequenceDiagram
participant Developer
participant TaskRunner
participant ClangFormatUtil
participant ChecksumUtil
participant MiscUtil
Developer->>TaskRunner: Run lint check
TaskRunner->>ClangFormatUtil: Execute check (cpp-format-check using G_CORE_DIR)
Developer->>TaskRunner: Request checksum validation
TaskRunner->>ChecksumUtil: Validate checksum (checksum:validate)
Developer->>TaskRunner: Execute text replacement
TaskRunner->>MiscUtil: Replace text (utils:misc:replace-text)
Possibly related PRs
Suggested reviewers
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 (
|
kirkrodrigues
left a comment
There was a problem hiding this comment.
For the PR title, how about:
build(taskfiles): Update to latest version of yscope-dev-utils; Replace cmake operations with cmake tasks; Add `clean-core` task.
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
lint-tasks.yml (1)
4-4: Core Directory Variable Declaration
The newG_CORE_DIRvariable neatly encapsulates the core component’s directory path. Ensure that you maintain consistency across the repository—if any other variable (such asG_CORE_COMPONENT_DIR) exists, consider consolidating them for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
lint-tasks.yml(6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (12)
- GitHub Check: centos-stream-9-static-linked-bins
- GitHub Check: ubuntu-focal-static-linked-bins
- GitHub Check: ubuntu-jammy-static-linked-bins
- GitHub Check: centos-stream-9-dynamic-linked-bins
- GitHub Check: ubuntu-focal-dynamic-linked-bins
- GitHub Check: ubuntu-jammy-dynamic-linked-bins
- GitHub Check: build-macos (macos-14, false)
- GitHub Check: build-macos (macos-13, false)
- GitHub Check: lint-check (ubuntu-latest)
- GitHub Check: build-macos (macos-13, true)
- GitHub Check: build (macos-latest)
- GitHub Check: lint-check (macos-latest)
🔇 Additional comments (10)
lint-tasks.yml (10)
28-30: Enhanced Source File References in cpp-check
Introducing source paths using{{.G_CORE_DIR}}improves maintainability and clarity by centralising the core file references. Please verify that these glob patterns correctly capture all relevant files (e.g., the clang-format configuration, source files, and test files) for your linting requirements.
32-32: Task Call Update for cpp-check
Changing the command from a directcppinvocation to thecpp-format-checktask streamlines the workflow and aligns with the updated naming conventions.
37-37: Refined Fix Task Implementation
The update to usecpp-format-fixin place of the previouscpptask improves clarity and modularity. This change is consistent with aligning all formatting tasks under the new naming standard.
108-118: Implementation of cpp-format-check Task
This new task block defines thecpp-format-checkprocess effectively by:
- Using the shared source files (
*cpp_source_files)- Setting the proper dependencies such as
cpp-lint-configsandvenv- Configuring a dry-run check with
--dry-runand the appropriate filename patterns
Please verify that the file patterns fully encompass all necessary files.
119-128: Implementation of cpp-format-fix Task
The correspondingcpp-format-fixtask is well configured with:
- The in-place fix flag
-i- Consistent use of the shared source files and variable settings
Ensure that this task does not inadvertently modify files outside the intended scope.
184-188: Checksum Validate Task Update
Integrating the:utils:checksum:validatetask in thelinter-node-modulessection is a good move for verifying file integrity. Please confirm that theCHECKSUM_FILEandINCLUDE_PATTERNSvariables are set correctly to target the desired directories.
193-197: Checksum Compute Task Update in Linter Section
The task call to:utils:checksum:computeis configured consistently with the validation task, ensuring that file integrity is re-verified after module operations.
210-214: Venv Checksum Validate Task
Within thevenvblock, using the:utils:checksum:validatetask upholds the checksum verification process. This aligns well with the overall consistency improvements across tasks.
215-219: Refinement of Virtual Environment Creation
Transitioning to the:utils:misc:create-venvtask reflects the updated naming convention and utility standardisation. This update should improve clarity and maintain the modular approach evident throughout the tasks.
221-224: Virtual Environment Checksum Computation
The final checksum computation within thevenvblock finalises the environment’s integrity check perfectly. Please double-check that the inclusion patterns are sufficiently comprehensive.
…or G_CORE_COMPONENT_DIR.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
lint-tasks.yml (1)
99-115: Configuration of thecpp-format-checkTask
The definition of thecpp-format-checktask is well structured. Using the alias*cpp_source_filesfor the source file list enhances maintainability. One minor note: the inclusion of"*.inc"in theINCLUDE_FILENAME_PATTERNSshould be verified. If support for.incfiles is not required by your coding standards, consider removing them; otherwise, it is fine as is.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
lint-tasks.yml(5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: build-macos (macos-14, false)
- GitHub Check: build-macos (macos-13, false)
- GitHub Check: build-macos (macos-13, true)
- GitHub Check: lint-check (ubuntu-latest)
- GitHub Check: build (macos-latest)
- GitHub Check: lint-check (macos-latest)
🔇 Additional comments (6)
lint-tasks.yml (6)
22-25: Task Naming Update for C++ Check Task
Thecpp-checktask now delegates to the updatedcpp-format-checktask. This change aligns with the new namespace convention introduced inyscope-dev-utils. Please ensure that all references to the old task name are updated uniformly across the codebase.
26-29: Task Naming Update for C++ Fix Task
Thecpp-fixtask now calls the updatedcpp-format-fixtask. This modification improves consistency with the new naming conventions. Confirm that any documentation or downstream configurations referencing the old task name are updated accordingly.
116-125: Configuration of thecpp-format-fixTask
Thecpp-format-fixtask mirrors the structure of its check counterpart and correctly uses the new task naming. As with the check task, please verify that the file extension patterns (including"*.inc") are intentional. This consistency is essential for ensuring that both tasks operate on the intended file set.
181-184: Checksum Validation Task Rename
The task call for checksum validation under thelinter-node-modulessection now uses:utils:checksum:validate, which is consistent with the new naming scheme. This update improves clarity and should be checked for consistency across any other modules that depend on this task.
190-194: Checksum Compute Task Rename
The update from the old checksum compute task to:utils:checksum:computeis correctly applied here, ensuring that the new naming conventions are consistently used in checksum operations.
207-221: Virtual Environment Task Update invenvSection
Within thevenvtask, the changes reflect the new naming conventions:
- The checksum validation now correctly uses
:utils:checksum:validate.- The task has been updated to call
:utils:misc:create-venvinstead of the oldcreate-venv, which enhances modularity and clarity.- The subsequent checksum compute step using
:utils:checksum:computeis also in line with the new framework.Overall, these updates improve the organizational structure and consistency across tasks.
yscope-dev-utils and fix breaking changes; Add clean-core task.yscope-dev-utils; Replace cmake operations with cmake tasks; Add clean-core task.
yscope-dev-utils; Replace cmake operations with cmake tasks; Add clean-core task.clean-core task.
…ce cmake operations with cmake tasks; Add `clean-core` task. (y-scope#734) Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Description
Bumps the version of
yscope-dev-utilsand fixes the breaking changes:dev-utils.cmaketask calls.cpp-linttask calls.clean-coretask that runs the cmake clean target.Checklist
breaking change.
Validation performed
Run tasks locally and passing CI.
Summary by CodeRabbit