Skip to content
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.

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

add a post by try-coderabbit #208

Merged
merged 1 commit into from
Nov 27, 2023
Merged

add a post by try-coderabbit #208

merged 1 commit into from
Nov 27, 2023

Conversation

pankona
Copy link
Owner

@pankona pankona commented Nov 27, 2023

Resolves: #204

Summary by CodeRabbit

  • ドキュメント
    • コード内のテキスト文字列を変更し、@coderabbit /reviewから@coderabbit reviewへと更新しました。これにより、コマンドの呼び出し方が改善されました。

Copy link

coderabbitai bot commented Nov 27, 2023

変更の概要

この変更は、コード内のテキスト文字列を"@coderabbit /review"から"@coderabbit review"に置き換えるというものです。この変更は、コードベース内のコマンドまたは関数呼び出しに関連しているようです。

変更点

ファイル 変更前 変更後
content/posts/try-coderabbit.md @coderabbit /review @coderabbit review

リンクされた課題に対する評価

目的 対応状況 説明
#204: CodeRabbit AIサービスをブログリポジトリに統合することを評価する。
CodeRabbit AIは、AIを使用して自動的にコードレビューを行うサービスです。
ブログのワークフローは、「article」ラベルの付いたイシューを作成し、それが自動的にプルリクエストを生成し、マージするとブログ投稿が公開されるというものです。
統合は、公開前にCodeRabbitがブログ投稿をレビューすることを目的としています。
CodeRabbitの設定は簡単で、所望のリポジトリに統合するのに約5分かかりました。
サービスはオープンソース(パブリックリポジトリ)利用については無料です。
公式ドキュメントと設定手順はhttps://coderabbit.ai/docs/introduction/で利用可能です。
CodeRabbitの効果は、https://github.com/pankona/pankona.github.com/pull/205のプルリクエストから推測できます。 プルリクエストの内容が詳細には記載されていないため、効果の評価は不明確です。
CodeRabbitは変更の概要にコメントし、「poem」を追加しますが、言語や可読性の改善に関するフィードバックは提供していないようです。 言語や可読性の改善に関するフィードバックはこの変更では対応されていません。
サービスは邪魔にならないため、著者は観察のためにそれを維持することに決めました。
設定はウェブUIまたはリポジトリのルートに.coderabbit.yamlファイルを配置することで行うことができます。
著者はRate Limitの問題に遭遇し、CodeRabbitにはレビューの時間制限があることを示唆しています。
執筆プロセスを完了した後にレビューを要求する方が、自動的に行うよりも効率的かもしれません。これにより、Rate Limitに達することを避けることができます。
著者は、作業中(WIP)ステータスが削除されたときに、@coderabbit reviewのようなスラッシュコマンドを使用してレビューを要求することを提案しています。

🐰💻🌟
コードの海に潜むバグを狩る
'@CodeRabbit review' と呼び出せば
AIの目が光り、レビューを始める
新しい変更、新たな旅立ちへ

\r\n\r\n自分が書いているこのブログサイトは以下の流れで記事が作られている。\r\n- issue を立てて article ラベルを貼り付ける\r\n- 自動的に issue の内容をちょいといい感じに整形した pull request が作成される\r\n- マージすればブログ記事が公開される\r\n\r\nスマホでも記事が書きたいし PC でも記事が書きたいし、せっかく GitHub pages でブログやってるんだからそれになんかいい感じ乗っかって楽ができないかなーと思って構築したのがこの仕組みである。スマホだけでも GitHub で issue を書きさえすればブログ記事が書けるってのはなかなか便利である (便利ではあるが別に記事が量産されるかというとそれは別の話ではある)。\r\n\r\nで、つまり記事が出ていく過程で pull request が一度生成されるようになっているわけで、先述の CodeRabbit さんに「ブログ記事を公開する前にいっちょレビューしてもらえる」って話ならば、なかなかもしかして便利で面白いのではないかと思ったわけである。\r\n\r\nCodeRabbit の導入はとても簡単で、5分もあれば所望のリポジトリに CodeRabbit を導入することができた。お値段は、Open Source (Public Repository) ならば無料で使いたい放題らしい。ほんまか?大丈夫か?\r\n\r\n公式ドキュメントはこちら https://coderabbit.ai/docs/introduction/\r\n導入方法なども紹介されていてたいへん親切であった。これでとても便利だったらとても嬉しい。\r\n\r\n---\r\n\r\nさて、本記事に対応する pull request は https://github.com//pull/205 である。\r\nここを見ると CodeRabbit がどんなようなことを言ってくれるものであるかなんとなく察することができるかと思う。\r\n\r\n![image](https://github.com/pankona/pankona.github.com/assets/6533008/1c6110e7-c182-493b-9183-f211233ef74a)\r\n\r\n![image](https://github.com/pankona/pankona.github.com/assets/6533008/12d8481e-7fe8-49dc-9d19-5042399d0803)\r\n\r\n変更の概要をコメントしてくれたり、あと謎のポエム?もつけてくれるようだ。文章のどこがおかしいとかもっとこうしたほうが読みやすいとか言ってくれたら嬉しかったが、そこまではしてくれない?ようだ (日本語だしソースコードじゃないってこともあろうか)。あんまり便利でもないがひとまず邪魔ではないので、いったん入れたままで様子を見てみようと思う。\r\n\r\nちなみに設定項目は Web の UI からぽちぽちいじってもいいし、リポジトリのてっぺんに `.coderabbit.yaml` を置いといても見てくれるようだ。たくさんのリポジトリに導入しようと思ったら設定ファイルを使うほうが便利そうね。\r\n\r\n---\r\n\r\n記事を何度か書き直している途中で Rate Limit に達してしまって CodeRabbit さんが動かなくなってしまった。一時間単位で Rate Limit が設定されているようなのでほっとけばまた動いてくれるのだと思う。とはいえそんなにヘビーにレビューをお願いしているわけでもないのにあっさり Rate Limit に達してしまうところを見るにつけては、一通り書き終わったところで一発レビューをお願いする (自動でレビューさせない) という使い方のほうがいいのかもしれない。\r\n\r\nスラッシュコマンド (dependabot を操作するのと同じようなやり口) でレビューの依頼ができるみたいなので、WIP が外れるところで一発 `@coderabbit review` みたいに書いてみるのが丸いやり方かしらね。","id":2008123175,"key":"#204","title":"try-coderabbit","createdAt":"2023-11-23T12:21:42Z","updatedAt":"2023-11-27T06:14:35Z","closedAt":"","user":"pankona","userType":"User","state":"open"},"summary":"- Evaluate the integration of CodeRabbit AI service into a blog repository.\n- CodeRabbit AI is a service that automatically performs code reviews using AI.\n- The blog's workflow involves creating an issue with an \"article\" label, which then automatically generates a pull request that, upon merging, publishes the blog post.\n- The integration aims to have CodeRabbit review the blog posts before they are published.\n- CodeRabbit was easy to set up, taking about 5 minutes to integrate into the desired repository.\n- The service is free for Open Source (Public Repository) use.\n- Official documentation and setup instructions are available at https://coderabbit.ai/docs/introduction/.\n- The effectiveness of CodeRabbit can be inferred from the pull request at https://github.com//pull/205.\n- CodeRabbit comments on the summary of changes and adds a \"poem\" but does not seem to provide feedback on language or readability improvements.\n- The service is not disruptive, so the author decides to keep it for observation.\n- Configuration can be done via the web UI or by placing a `.coderabbit.yaml` file at the root of the repository.\n- The author encountered a Rate Limit issue, suggesting that CodeRabbit has an hourly limit on reviews.\n- It may be more efficient to request a review after completing the writing process rather than automatically, to avoid hitting the Rate Limit.\n- The author suggests using a slash command (similar to dependabot) to request a review, such as `@coderabbit review`, when the work-in-progress (WIP) status is removed."}]]

-->


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@pankona pankona merged commit 3c5f2f8 into main Nov 27, 2023
4 checks passed
@pankona pankona deleted the try-coderabbit branch November 27, 2023 06:20
@kachick
Copy link
Collaborator

kachick commented Nov 27, 2023

詩

🐰💻🌟
コードの海に潜むバグを狩る
'@CodeRabbit review' と呼び出せば
AIの目が光り、レビューを始める
新しい変更、新たな旅立ちへ

まさかのオートポエム

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

try-coderabbit
2 participants