Skip to content

Add comprehensive README documentation for MariaDB Profiler#15

Merged
39ff merged 6 commits into
mainfrom
claude/create-readme-qteMs
Feb 17, 2026
Merged

Add comprehensive README documentation for MariaDB Profiler#15
39ff merged 6 commits into
mainfrom
claude/create-readme-qteMs

Conversation

@39ff

@39ff 39ff commented Feb 17, 2026

Copy link
Copy Markdown
Owner

Summary

This PR adds complete documentation for the MariaDB Profiler for PHP project, providing users with a comprehensive guide to understand, install, configure, and use the profiler across all its components.

Changes

  • Added README.md with full project documentation including:
    • Project overview explaining the profiler's purpose and scope
    • Component breakdown (PHP extension, CLI tool, Docker demo, JetBrains plugin)
    • Feature list highlighting key capabilities (query interception, context tagging, backtrace support, etc.)
    • System requirements for each component
    • Step-by-step installation instructions for the PHP extension
    • Configuration reference for all php.ini directives
    • Usage examples for CLI commands and PHP API
    • Demo environment setup instructions
    • PHP function reference documentation
    • Log format specification

Notable Details

  • Documentation covers support for PHP 5.3 through 8.4+
  • Includes examples for all major CLI operations (job management, analysis, export)
  • Provides code examples for tagging API usage
  • Documents both raw text and JSON log formats
  • Supports multiple database access methods (PDO, mysqli, Laravel Eloquent)

https://claude.ai/code/session_014xLvguaiUykzwTi2VzaA6g

Summary by CodeRabbit

Summary by CodeRabbit

リリースノート

  • ドキュメント

    • MariaDB Profiler for PHPの包括的なドキュメントを追加しました。インストール、設定、使用例、CLI/拡張の説明を含みます。
  • チューニング(CI)

    • CI実行制御を改善:重複実行の自動キャンセルと、PRに「no_run」ラベルが付いた場合のジョブスキップを導入しました。
  • リリース

    • リリースにJetBrainsプラグインのビルドとZIPアーティファクト収集を追加しました。

--

ss0 ss1 ss2

プロジェクト概要、構成、インストール手順、設定、使い方、
PHP関数リファレンス、ログ形式をまとめたREADMEを追加。

https://claude.ai/code/session_014xLvguaiUykzwTi2VzaA6g
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@coderabbitai

coderabbitai Bot commented Feb 17, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉


Walkthrough

複数のGitHub Actionsワークフローにトップレベルのconcurrencyと、PRに no_run ラベルが付与されている場合にジョブをスキップするジョブレベルの条件(if: github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, 'no_run'))が追加されました。README.mdが新規追加されました。

Changes

Cohort / File(s) Summary
GitHub Actions: general workflows
/.github/workflows/demo-e2e.yml, /.github/workflows/plugin-build.yml, /.github/workflows/tests.yml, /.github/workflows/windows-build.yml
トップレベルに concurrency ブロックを追加。各ワークフロー内の該当ジョブにPRで no_run ラベルがある場合に実行をスキップする if 条件を追加。
Release workflow updates
/.github/workflows/release.yml
リリースフローに「JetBrains Plugin」ジョブを追加し、リリース依存関係に組み込む。アーティファクト収集を .zip 含めるよう拡張し、アーティファクトのダウンロード手順を追加。
Documentation
README.md
「MariaDB Profiler for PHP」の包括的なドキュメントを新規追加(コンポーネント、インストール、設定、使用例、CLI、PHP関数リファレンス、ログ形式など)。

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰
小さなラビット、コードを跳ねて
ワークフローは静かに並び替えられた
ラベルひとつで走るか休むか決めて
READMEは庭に花を咲かせる
ぴょん、リリースへ向けてまた走る♪

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR titleは「Add comprehensive README documentation for MariaDB Profiler」で、README.mdファイルの追加という主要な変更を正確に反映しており、簡潔で明確です。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch claude/create-readme-qteMs

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Add job-level condition to tests, demo-e2e, plugin-build, and
windows-build workflows so they are skipped when the pull request
carries the "no_run" label. Push events are unaffected.

https://claude.ai/code/session_014xLvguaiUykzwTi2VzaA6g

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 31: README の CLI ツール欄が「PHP 5.3+」となっていますが実際の最低要件は依存パッケージの nullable 型ヒントにより
PHP 7.1+(CI のテストは PHP 7.4+ で回している)なので、README.md の該当テーブル行(現在 "CLI tool | PHP
5.3+, Composer" とある箇所)を "PHP 7.1+, Composer" に修正し、必要なら tests.yml の test-cli
ジョブコメントに greenlion/php-sql-parser が PHP 7.1+ を要求する旨を明記して整合させてください。

Comment thread README.md
| Component | Requirements |
|---|---|
| Extension | PHP 5.3 – 8.4+, mysqlnd |
| CLI tool | PHP 5.3+, Composer |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

CLIツールのPHPバージョン要件がCIと矛盾しています。

READMEでは「PHP 5.3+」と記載されていますが、tests.ymltest-cli ジョブでは PHP 7.4 以降のみテストされており、コメントにも greenlion/php-sql-parser が nullable type hints (?Type) を使用するため PHP 7.1+ が必要と明記されています。実際の最低要件に合わせて記載を修正してください。

📝 修正案
-| CLI tool | PHP 5.3+, Composer |
+| CLI tool | PHP 7.4+, Composer |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| CLI tool | PHP 5.3+, Composer |
| CLI tool | PHP 7.4+, Composer |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 31, README の CLI ツール欄が「PHP 5.3+」となっていますが実際の最低要件は依存パッケージの
nullable 型ヒントにより PHP 7.1+(CI のテストは PHP 7.4+ で回している)なので、README.md の該当テーブル行(現在
"CLI tool | PHP 5.3+, Composer" とある箇所)を "PHP 7.1+, Composer" に修正し、必要なら tests.yml
の test-cli ジョブコメントに greenlion/php-sql-parser が PHP 7.1+ を要求する旨を明記して整合させてください。

Add concurrency groups to tests, demo-e2e, plugin-build, and
windows-build workflows. When a new push arrives while a previous
run is still in progress, the older run is automatically cancelled.

https://claude.ai/code/session_014xLvguaiUykzwTi2VzaA6g
@39ff 39ff added the no_run label Feb 17, 2026
claude and others added 2 commits February 17, 2026 12:43
Build the JetBrains plugin and include the .zip in release assets
alongside the Linux .so and Windows .dll files.

https://claude.ai/code/session_014xLvguaiUykzwTi2VzaA6g
Added section about IntelliJ plugin compatibility with images.
@39ff 39ff merged commit 43413c4 into main Feb 17, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants