8000 chore: openhandsにpre-commitを追加 by sun-yryr · Pull Request #130 · sun-yryr/Rec-adio · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

chore: openhandsにpre-commitを追加 #130

8000
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
May 17, 2025
Merged

chore: openhandsにpre-commitを追加 #130

merged 2 commits into from
May 17, 2025
+26 −4

Conversation

sun-yryr
Copy link
Owner
@sun-yryr sun-yryr commented May 17, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • コード品質チェック（GoとProtocol Buffers用）の自動実行を行うGitのpre-commitフックを追加しました。
    • セットアップスクリプトの堅牢性と可読性を向上し、Gitのhooksパスを自動設定する処理を追加しました。

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented May 17, 2025 •
edited
Loading

Walkthrough

この変更では、新しいGit pre-commitフックスクリプトが追加され、GoコードとProtocol Buffersのリント・フォーマットチェックをコミット前に自動実行するようになりました。また、setup.shスクリプトが堅牢性とShellCheck準拠のために改良され、Gitのhooksパスを.githooksに設定するコマンドが追加されました。

Changes

ファイル/パス 変更内容概要
.githooks/pre-commit 新規追加。GoとProtocol Buffersのリント・フォーマットをコミット前に自動実行するpre-commitフックスクリプトを追加。
.../setup.sh ShellCheck対応の強化、エラーハンドリングの改善、パスの引用、Git hooksパス設定コマンドの追加。

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Git (pre-commit)
    participant golangci-lint
    participant buf

    Developer->>Git (pre-commit): git commit
    Git (pre-commit)->>golangci-lint: golangci-lint run
    Git (pre-commit)->>buf: buf lint
    Git (pre-commit)->>buf: buf format -w --exit-code
    Git (pre-commit)->>Developer: コミット継続またはエラーで中断
Loading

Poem

うさぎが跳ねる、コミットの前に、
リンターとバッファでコードをきれいに、
setupも整え、hooksも新た、
みんなで守ろう、品質の旗！
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit 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.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit 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 Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc6b529 and e0dc5ab.

📒 Files selected for processing (2)
  • .githooks/pre-commit (1 hunks)
  • .openhands/setup.sh (3 hunks)
🔇 Additional comments (6)
.openhands/setup.sh (4)

2-2: shellcheckの警告を無効化する設定が追加されました

SC1090（定数でないファイルをsourceする際の警告）を無効化することで、スクリプトの静的解析時に不要な警告を抑制できるようになりました。

4-4: ディレクトリ変更の堅牢性が向上しました

cd コマンドに || exit を追加することで、ディレクトリ変更が失敗した場合にスクリプトが即座に終了するようになりました。これはシェルスクリプトの堅牢性を向上させるためのベストプラクティスです。

Also applies to: 8-8, 29-29

18-18: golangci-lintのインストールコマンドが改善されました

GOPATHを引用符で囲むことで、パスに空白が含まれる場合でも正しく処理されるようになりました。

33-33: Gitのhooksパスが設定されました

.githooksディレクトリをGitのhooksパスとして設定することで、新しく追加されたpre-commitフックが自動的に有効になります。これはコード品質を保証するための重要な追加です。

.githooks/pre-commit (2)

1-20: 効果的なpre-commitフックが追加されました

このpre-commitフックスクリプトは以下の点で優れています：

  1. set -eでエラー時に即座に終了するように設定されています
  2. Go言語コードをgolangci-lintでチェックします
  3. Protocol Buffersファイルに対して、lintチェックとフォーマットチェックを実行します
  4. 各ステップの前と成功時に明確なステータスメッセージを表示します

このフックにより、コミット前に自動的にコード品質のチェックが行われるため、品質の高いコードベースを維持するのに役立ちます。

17-17: buf formatコマンドの使用は適切です

-wフラグでフォーマットの問題を自動修正し、--exit-codeフラグでフォーマットエラーがあった場合にコミットを中止するようになっています。これにより、コミットされるProtocol Buffersファイルが常に正しくフォーマットされていることが保証されます。

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@github-actions GitHub Actions
Copy link

The latest Buf updates on your PR. Results from workflow Check Proto / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedMay 17, 2025, 4:30 AM

@sun-yryr sun-yryr merged commit 23904fb into v4 May 17, 2025
6 checks passed
@sun-yryr sun-yryr deleted the chore/opanhands-precommit branch May 17, 2025 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@sun-yryr sun-yryr

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sun-yryr
0