chore: world create shallow clone for latest tag

[zulkhair]

Closes: PLAT-9

Overview

Optimize world create shallow clone for latest tag

Brief Changelog

• Clone only the latest tag (shallow clone)
• Improved error handling with clearer messages.

Testing and Verifying

• Manually tested using world create command
• Adjusted unit test

Summary by CodeRabbit

• Refactor
  • Improved error handling in Git operations, providing clearer feedback during errors.
  • Simplified the function signature for GitCloneCmd and revised logic for fetching the latest Git tag.
• Tests
  • Updated the expected error response for invalid Git addresses to reflect the new behavior.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request refines the GitCloneCmd function by improving error handling and streamlining its logic. The updated implementation now wraps errors with descriptive messages using eris.Errorf and eris.Wrapf and simplifies the function signature. Furthermore, it modifies the cloning process to directly use the latest Git tag with a shallow clone (depth of 1). A related unit test was adjusted to reflect the new expected error exit code for invalid URL inputs.

Changes

File(s)	Change Summary
common/teacmd/git.go	Enhanced error handling using eris.Errorf and eris.Wrapf, simplified the function signature, updated logic to fetch and clone using the latest Git tag with depth 1.
common/teacmd/git_test.go	Updated the expected exit status for the "error clone wrong address" test case from 128 to 1.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant GitCloneCmd
    participant Git
    alt Successful Clone
        Caller->>GitCloneCmd: Call GitCloneCmd(url, targetDir, initMsg)
        GitCloneCmd->>Git: Fetch latest tag from remote
        Git-->>GitCloneCmd: Return latest tag
        GitCloneCmd->>Git: Clone repository using latest tag with depth=1
        GitCloneCmd->>Git: Execute post-clone cleanup and initialization steps
        GitCloneCmd-->>Caller: Return success
    else Error Handling
        Caller->>GitCloneCmd: Call GitCloneCmd(url, targetDir, initMsg)
        GitCloneCmd->>Git: Attempt git operation
        Git-->>GitCloneCmd: Return error
        GitCloneCmd-->>Caller: Return wrapped error with context
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Update World CLI to git clone only the latest commit (PLAT-9)	✅

Possibly related PRs

• fix: check dir is exists before create/clone on world cardinal create command #83: Introduces a validation step to check for existing directories in the GitCloneCmd function, indicating a direct relationship with the error handling and cloning logic changes in this PR.

Suggested reviewers

• smsunarto
• rmrt1n

---

📜 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 05bbd03 and 04b15a3.

📒 Files selected for processing (2)

• common/teacmd/git.go (5 hunks)
• common/teacmd/git_test.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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.

[zulkhair]

• chore: world create shallow clone for latest tag #97 👈 (View in Graphite)
• main

---

How to use the Graphite Merge Queue

Add the label graphite/merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[graphite-app]

Merge activity

• Feb 7, 4:58 AM EST: A user added this pull request to the Graphite merge queue.
• Feb 7, 5:00 AM EST: A user merged this pull request with the Graphite merge queue.