fix(taskfiles): Make remote utilities macOS-compliant. #21

Bill-hbrhbr · 2025-02-12T04:15:23Z

Description

Replace unsupported long options in mkdir and rm with their shorthand equivalents for cross-platform compatibility.
Use GNU tar instead of tar on macOS.
- The tar command doesn't support --directory, --no-anchored, or --wildcards.
  - There is a shorthand -C option as an alternative to --directory.
  - The other two options are not available.

References:
gtar: https://linux.die.net/man/1/gtar
tar: https://ss64.com/mac/tar.html

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

Succeeds in passing MacOS workflows of ystdlib-cpp.

Summary by CodeRabbit

New Features
- Improved archive extraction by automatically selecting the appropriate tool for your operating system.
Chores
- Streamlined file handling techniques by optimising directory creation and removal commands for enhanced efficiency.

coderabbitai · 2025-02-12T04:15:31Z

Walkthrough

The pull request updates the taskfiles/utils-remote.yaml file. It simplifies the directory creation commands by replacing mkdir --parents with mkdir -p in both the curl and download-and-extract-tar tasks. It also changes the directory removal command to use rm -rf. Additionally, a new variable ARCHIVER is introduced to choose between gtar (for macOS) and tar (for other operating systems), thereby adjusting the extraction process based on the platform.

Changes

File	Change Summary
taskfiles/utils-remote.yaml	Updated `curl` task to use `mkdir -p` instead of `mkdir --parents`; modified `download-and-extract-tar` task by replacing `rm --force --recursive` with `rm -rf` and `mkdir --parents` with `mkdir -p`; added new variable `ARCHIVER` to select `gtar` for macOS and `tar` for other OS.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TaskExecutor
    participant OSCheck
    participant Shell

    User->>TaskExecutor: Start download-and-extract-tar task
    TaskExecutor->>OSCheck: Determine operating system
    OSCheck-->>TaskExecutor: Return OS type (darwin/other)
    alt macOS
        TaskExecutor->>Shell: Use "gtar" for extraction
    else
        TaskExecutor->>Shell: Use "tar" for extraction
    end
    TaskExecutor->>Shell: Remove output directory (rm -rf)
    TaskExecutor->>Shell: Create output directory (mkdir -p)
    TaskExecutor->>Shell: Download and extract tar archive using ARCHIVER

Possibly related PRs

feat(taskfiles): Add cmake and remote utils; Update checksum data path to an array. #16: Adjustments in the download-and-extract-tar task are similar to changes introduced in this PR.
feat(taskfiles)!: Split utils taskfile by category; Rename extension from yml to yaml. #18: Modifications to both the download-and-extract-tar and curl tasks in the same file indicate a strong code-level connection.

Suggested reviewers

kirkrodrigues

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5551a6c and ff5cb14.

📒 Files selected for processing (1)

taskfiles/utils-remote.yaml (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

taskfiles/utils-remote.yaml

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?

❤️ 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.
- Generate unit testing code for this file.
- 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. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
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 src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

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

Documentation and Community

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.

kirkrodrigues · 2025-02-12T19:49:49Z

taskfiles/utils-remote.yaml

@@ -77,6 +77,8 @@ tasks:
        ref: "default (list) .INCLUDE_PATTERNS"

      # Misc
+      ARCHIVER: >-
+          {{if eq OS "darwin"}}gtar{{else}}tar{{end}}


Why do we want to use gtar on macOS?

The tar command doesn't support --directory, --no-anchored, or --wildcards. However, it does provide the shorthand -C option as an alternative to --directory, but the other two options are not available in the default version of tar.

References:
gtar: https://linux.die.net/man/1/gtar
tar: https://ss64.com/mac/tar.html

Can you add that to the PR description?

kirkrodrigues

For the PR title, how about:

fix(taskfiles): Make remote utilities macOS-compliant.

taskfiles/utils-remote.yaml

Co-authored-by: kirkrodrigues <[email protected]>

Bill-hbrhbr added 5 commits February 11, 2025 23:01

Make utils-remote macos-compliant

8fe068c

fix

8e98d9b

syntax fix

51d8cd6

syntax fix

10feecf

newline fix

5551a6c

Bill-hbrhbr requested review from davidlion and kirkrodrigues February 12, 2025 04:15

Bill-hbrhbr marked this pull request as ready for review February 12, 2025 04:18

kirkrodrigues reviewed Feb 12, 2025

View reviewed changes

Bill-hbrhbr requested a review from kirkrodrigues February 12, 2025 22:12

kirkrodrigues reviewed Feb 12, 2025

View reviewed changes

taskfiles/utils-remote.yaml Outdated Show resolved Hide resolved

Bill-hbrhbr requested a review from kirkrodrigues February 12, 2025 23:22

Update taskfiles/utils-remote.yaml

ff5cb14

Co-authored-by: kirkrodrigues <[email protected]>

Bill-hbrhbr changed the title ~~fix: Make Taskfile remote utilities macOS-compliant.~~ fix(taskfiles): Make remote utilities macOS-compliant. Feb 12, 2025

kirkrodrigues approved these changes Feb 12, 2025

View reviewed changes

Bill-hbrhbr merged commit dcba500 into y-scope:main Feb 12, 2025
1 check passed

Bill-hbrhbr deleted the remote-macos-fix branch February 12, 2025 23:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(taskfiles): Make remote utilities macOS-compliant. #21

fix(taskfiles): Make remote utilities macOS-compliant. #21

Bill-hbrhbr commented Feb 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 12, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

kirkrodrigues Feb 12, 2025

Bill-hbrhbr Feb 12, 2025

Bill-hbrhbr Feb 12, 2025

kirkrodrigues Feb 12, 2025

Bill-hbrhbr Feb 12, 2025

Bill-hbrhbr Feb 12, 2025

kirkrodrigues left a comment

fix(taskfiles): Make remote utilities macOS-compliant. #21

fix(taskfiles): Make remote utilities macOS-compliant. #21

Conversation

Bill-hbrhbr commented Feb 12, 2025 • edited by coderabbitai bot Loading

Description

Checklist

Validation performed

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai bot commented Feb 12, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

kirkrodrigues Feb 12, 2025

Choose a reason for hiding this comment

Bill-hbrhbr Feb 12, 2025

Choose a reason for hiding this comment

Bill-hbrhbr Feb 12, 2025

Choose a reason for hiding this comment

kirkrodrigues Feb 12, 2025

Choose a reason for hiding this comment

Bill-hbrhbr Feb 12, 2025

Choose a reason for hiding this comment

Bill-hbrhbr Feb 12, 2025

Choose a reason for hiding this comment

kirkrodrigues left a comment

Choose a reason for hiding this comment

Bill-hbrhbr commented Feb 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 12, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)