refactor(taskfiles)!: Rename and reorganize utils:cmake:install-remote-tar's parameters.
#55
Conversation
…ake:install-remote-tar`.
## Walkthrough
The change refactors the parameter names and organization for the `install-remote-tar` task in `cmake.yaml`. It introduces consistent prefixes (`TAR_` and `CMAKE_`) for related parameters, updates required variables, and revises comments for clarity. No logic or control flow within the tasks is altered.
## Changes
| File(s) | Change Summary |
|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| exports/taskfiles/utils/cmake.yaml | Refactored parameter names for the `install-remote-tar` task, grouped parameters by function, updated `requires.vars`, revised comments, and reorganized parameter defaults. No changes to task logic or control flow. |
## Possibly related PRs
- y-scope/yscope-dev-utils#22: Refactored and renamed parameters for the same `install-remote-tar` task, directly modifying its parameter structure.
- y-scope/yscope-dev-utils#41: Added functionality to write CMake settings and manage dependencies, including updates to the `install-remote-tar` task and its parameters.
- y-scope/yscope-dev-utils#27: Renamed tasks and restructured namespaces in the same taskfile, affecting the `install-remote-tar` task from a structural perspective.
## Suggested reviewers
- kirkrodriguesNote ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (11)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🔭 Outside diff range comments (1)
exports/taskfiles/utils/cmake.yaml (1)
192-206:⚠️ Potential issueReference new CMake argument variables in
generateandbuildcalls.
The invocations of thegenerateandbuildsubtasks still map to old variables (.GEN_ARGS,.BUILD_ARGS,.JOBS,.TARGETS). They should use.CMAKE_GEN_ARGS,.CMAKE_BUILD_ARGS,.CMAKE_JOBS, and.CMAKE_TARGETS.- - task: "generate" - vars: - BUILD_DIR: "{{.BUILD_DIR}}" - EXTRA_ARGS: - ref: ".GEN_ARGS" - SOURCE_DIR: "{{.SOURCE_DIR}}" + - task: "generate" + vars: + BUILD_DIR: "{{.BUILD_DIR}}" + EXTRA_ARGS: + ref: ".CMAKE_GEN_ARGS" + SOURCE_DIR: "{{.SOURCE_DIR}}" - - task: "build" - vars: - BUILD_DIR: "{{.BUILD_DIR}}" - EXTRA_ARGS: - ref: ".BUILD_ARGS" - JOBS: "{{.JOBS}}" - TARGETS: - ref: ".TARGETS" + - task: "build" + vars: + BUILD_DIR: "{{.BUILD_DIR}}" + EXTRA_ARGS: + ref: ".CMAKE_BUILD_ARGS" + JOBS: "{{.CMAKE_JOBS}}" + TARGETS: + ref: ".CMAKE_TARGETS"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
exports/taskfiles/utils/cmake.yaml(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: unit-tests (ubuntu-22.04)
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
davidlion
changed the title
utils:cmake:install-remote-tar.utils:cmake:install-remote-tar's parameters.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
exports/taskfiles/utils/cmake.yaml(1 hunks)
🔇 Additional comments (10)
exports/taskfiles/utils/cmake.yaml (10)
132-136: Well-documented required parametersThe newly required parameters
NAME,TAR_SHA256,TAR_URL, andWORK_DIRare annotated with concise JSDoc comments, improving discoverability and reducing onboarding friction.
139-151: Clear CMake parameter annotationsAll CMake-related parameters (
CMAKE_BUILD_ARGS,CMAKE_GEN_ARGS,CMAKE_INSTALL_ARGS,CMAKE_JOBS,CMAKE_SETTINGS_DIR,CMAKE_TARGETS) now carry consistent prefixes, default values, and descriptive comments, enhancing clarity and preventing ambiguity.
153-158: Directory parameter defaultsThe directory parameters (
BUILD_DIR,INSTALL_PREFIX,SOURCE_DIR) are sensibly defaulted relative toWORK_DIRandNAME, reducing boilerplate and potential misconfigurations.
161-161: Updated task labelThe task label now correctly uses
{{.TAR_URL}}in place of the old{{.URL}}, ensuring generated labels match the renamed parameter.
164-175: Refactored vars block for optional parametersThe
varssection cleanly references the newCMAKE_*variables for defaults, aligning task internals with the renamed parameters and avoiding stale references.
178-183: Proper grouping of directory varsThe
BUILD_DIR,INSTALL_PREFIX, andSOURCE_DIRdefaults leverageprintfwithWORK_DIRandNAME, making directory layout predictable and consistent.
185-186: Accurate required variables listThe
requires.varsarray now accurately lists the breaking-change parameters (NAME,TAR_SHA256,TAR_URL,WORK_DIR), reflecting the updated signature.
188-192: Corrected download dependency parameter mappingThe
remote:download-and-extract-tardependency is updated to pullFILE_SHA256fromTAR_SHA256andURLfromTAR_URL, ensuring the download step gets the right inputs.
194-200: Generate subtask invocation updatedThe
generatecall correctly mapsEXTRA_ARGSfrom.CMAKE_GEN_ARGS, maintaining consistency with the renamed generate parameters.
208-216: Install subtask aligns with renamed parametersThe
installcall now leveragesEXTRA_ARGSfrom.CMAKE_INSTALL_ARGSand correctly references other updated variables, completing the parameter rename across all subtasks.
Description
As title says.
Checklist
breaking change.
Validation performed
Test changes locally with tasks inside log-surgeon.
Summary by CodeRabbit