Feat: Pre push hook

[cristianFleita]

Pull Request Overview

📝 Summary

• Closes Implement pre push hook to run sozo test and sozo build #79

🔄 Changes Made

• Git Hooks Implementation:
  • Added pre-push hook that automatically runs sozo test before any code push
• Makefile Enhancements: Added three new commands
  1. make init:
     • Sets up Git hooks infrastructure
     • Creates and configures pre-push hook
  2. make katana:
     • Launches Katana
  3. make setup:
     • Builds the project
     • Initializes Torii

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced new katana, setup, and init targets to enhance the build process.
  • Added a setup.sh script for automated project setup and service initialization.
  • Expanded installation instructions in the README, including direct links for Git and Scarb installation.

• Bug Fixes

  • Implemented a pre-push Git hook to ensure code quality by running tests before pushing.

• Documentation

  • Updated README with clearer setup instructions and improved formatting for readability.

[coderabbitai]

Walkthrough

The changes in this pull request primarily involve updates to the Makefile, the addition of a new setup.sh script, and modifications to the README.md file. The Makefile now includes new targets: katana, setup, and init, enhancing the build process and facilitating the initialization of Git hooks. The init target specifically sets up a pre-push hook that runs the sozo test and sozo build commands, providing feedback based on the test results. The setup.sh script automates the project setup, including directory cleanup, project building, migration application, and service initialization. Additionally, the README.md has been updated to clarify installation instructions for Git, Scarb, Dojo, and the new setup process, including a section on configuring Git hooks. Several ABI definition files related to the bytebeasts model have been deleted, indicating a significant structural change in the codebase.

Assessment against linked issues

Objective	Addressed	Explanation
Pre-push hook to automatically run sozo commands.	✅
Updated documentation with setup instructions.	✅
Makefile with an init command to enable the hooks.	✅

Possibly related PRs

• README improvements #72: The README improvements include updates to the installation command for dojoup, which aligns with the new setup target added in the main PR's Makefile, enhancing the setup process for users.

Suggested labels

documentation

Suggested reviewers

• danielcdz
• RolandoDrRobot

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 10

🧹 Outside diff range and nitpick comments (4)

README.md (4)

55-57: Enhance Git installation instructions.

Consider adding:

• Minimum required Git version
• Command to verify installation: git --version

 Go to the [Git installation page](https://git-scm.com/downloads) and follow the instructions for your operating system to install Git.
+
+After installation, verify Git is properly installed:
+```bash
+git --version  # Should show v2.0.0 or higher
+```

---

74-75: Fix code block formatting.

Add proper code block markers for consistency with other commands in the document.

-dojoup --version 1.0.0-alpha.5
+```bash
+dojoup --version 1.0.0-alpha.5
+```

---

106-126: Add hook bypass and troubleshooting information.

The Git hooks section should include:

1. How to temporarily bypass hooks if needed
2. Troubleshooting steps for common issues

 ```bash
 # Run Katana
 make init

+#### Bypassing Hooks
+
+In cases where you need to bypass the pre-push hook (use with caution):
+bash +git push --no-verify +
+
+#### Troubleshooting
+
+If you encounter issues with the hooks:
+1. Ensure sozo is properly installed and in your PATH
+2. Check hook permissions: ls -l .git/hooks/pre-push
+3. Verify hook installation: make init

---

Line range hint `55-150`: **Improve document consistency and structure.**

The document has inconsistent formatting:
1. Some sections have emojis while others don't
2. Inconsistent spacing between sections
3. Varying heading levels and formats

Consider standardizing:
- Emoji usage across all major sections
- Spacing between sections (one blank line)
- Command block formatting
- Heading hierarchy

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Files that changed from the base of the PR and between 38a20c2b847b0a3f298cf010658249564e5c27ed and 0bc9e7ea7df65613dfcfda15e06bc7b440e0bc9a.

</details>

<details>
<summary>📒 Files selected for processing (7)</summary>

* Makefile (1 hunks)
* README.md (2 hunks)
* manifests/dev/deployment/abis/models/bytebeasts-DirectionsAvailable-48430624.json (0 hunks)
* manifests/dev/deployment/abis/models/bytebeasts-Message-23adac1f.json (0 hunks)
* manifests/dev/deployment/abis/models/bytebeasts-Moved-2a5b60a4.json (0 hunks)
* manifests/dev/deployment/abis/models/bytebeasts-Moves-b282ed29.json (0 hunks)
* scripts/setup.sh (1 hunks)

</details>

<details>
<summary>💤 Files with no reviewable changes (4)</summary>

* manifests/dev/deployment/abis/models/bytebeasts-DirectionsAvailable-48430624.json
* manifests/dev/deployment/abis/models/bytebeasts-Message-23adac1f.json
* manifests/dev/deployment/abis/models/bytebeasts-Moved-2a5b60a4.json
* manifests/dev/deployment/abis/models/bytebeasts-Moves-b282ed29.json

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 Shellcheck</summary><blockquote>

<details>
<summary>scripts/setup.sh</summary><blockquote>

[warning] 17-17: Declare and assign separately to avoid masking return values.

(SC2155)

</blockquote></details>

</blockquote></details>

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>Makefile (1)</summary><blockquote>

`28-31`: **LGTM! Good error handling for undefined commands.**

The catch-all rule provides clear feedback when users attempt to run undefined commands.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[danielcdz]

awesome @cristianFleita ! 🚀 we are testing this but it looks pretty good overall, thank you!

[coxmars]

Hi @cristianFleita, I tested the pre-push hook and it looks good. Great job this will be really helpful! 🚀

[danielcdz]

LGTM 🚀