refactor(taskfiles)!: Remove ability to set build/install/source-dir paths (in favour of putting them inside WORK_DIR) in utils:cmake:install-remote-tar.
#56
Conversation
…nstall-remote-tar`.
WalkthroughThe change updates the Changes
Possibly related PRs
Suggested reviewers
Note ⚡️ 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 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}
| BUILD_DIR: "{{.WORK_DIR}}/{{.NAME}}-build" | ||
| INSTALL_PREFIX: "{{.WORK_DIR}}/{{.NAME}}-install" | ||
| SOURCE_DIR: "{{.WORK_DIR}}/{{.NAME}}-src" |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Clarify fixed directory paths and update documentation.
We’ve removed the ability to override BUILD_DIR, INSTALL_PREFIX, and SOURCE_DIR in favour of always placing them under WORK_DIR. Please update the task’s doc comments (and any examples/README) to remove references to these as overridable parameters, and consider adding an inline note here to explain that these paths are now fixed.
🤖 Prompt for AI Agents
In exports/taskfiles/utils/cmake.yaml around lines 170 to 172, the variables
BUILD_DIR, INSTALL_PREFIX, and SOURCE_DIR are now fixed to be under WORK_DIR and
cannot be overridden. Update the task's documentation comments and any related
examples or README files to remove mentions of these as overridable parameters.
Additionally, add an inline comment near these lines explaining that these
directory paths are fixed and always relative to WORK_DIR.
2 participants
Description
Currently there is a weird case where if all build, install, and source directory paths are specified then the required parameter
WORK_DIRis unused.Rather than adding logic to check the combination of variables, we're simply removing the these directory paths from being optional parameters. Since
utils:cmake:install-remote-tarrequires a working CMake project there was no reason to override these directories and existing use cases were already just letting the directories default to be insideWORK_DIR.Checklist
breaking change.
Validation performed
Tested locally with log-surgeon.
Summary by CodeRabbit