adding branch info to reporting

[alexcoderabbitai]

No description provided.

[coderabbitai]

Walkthrough

The custom reports guide has been updated to include two additional data points for pull requests. The documentation now specifies the branch details by introducing Source branch (the originating branch) and Target branch (the intended merge destination). No changes were made to processing or functionality.

Changes

File	Change Summary
docs/guides/custom-reports.md	Added two new data points: Source branch and Target branch for PR branch info.

Poem

Hopping through lines of text so bright,
I add new branches with delight.
Source branch and Target branch,
A bunny’s update, a joyful dance!
Celebrating changes in the code’s light 🐇✨

---

🪧 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.
• @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: 0

🧹 Nitpick comments (1)

docs/guides/custom-reports.md (1)

89-90: New Branch Data Points Added

The addition of the Source branch and Target branch fields is clearly presented in the "Available Data Points" section and follows the existing bullet point formatting. Verify that these new fields correctly reflect the API/underlying data model, and consider adding a brief note in the accompanying documentation (if not already present) to indicate how these values are populated in custom reports.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 30c400a and 1372777.

📒 Files selected for processing (1)

• docs/guides/custom-reports.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	1372777
Status:	✅  Deploy successful!
Preview URL:	https://a2e50165.coderabbit-docs.pages.dev
Branch Preview URL:	https://feat-reporting-branches.coderabbit-docs.pages.dev

View logs