Skip to content

add in docs for new reporting filtering and data #461

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 6 commits into from
Jul 17, 2025
Merged

add in docs for new reporting filtering and data #461

merged 6 commits into from
Jul 17, 2025

Conversation

alexcoderabbitai
Copy link
Collaborator

No description provided.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 17, 2025 •
edited
Loading

Walkthrough

The documentation for custom and scheduled reports was updated. For custom reports, a new section details how to include CI/CD check status information for GitHub pull requests. For scheduled reports, the filtering options were clarified to explicitly mention inclusion and exclusion of pull requests and labels using the IN and NOT_IN operators. Additionally, a changelog entry was added describing these enhancements along with new exclusion filters, a "Next Steps" section in the default daily standup report template, and a new score card custom report option.

Changes

File(s) Change Summary
docs/guides/custom-reports.md Added section on <pr_checks> and <pr_check> for CI/CD check status; updated warning on Score Card/Chart bot comment flow; corrected final score calculation from 5 to 9.
docs/guides/scheduled-reports.md Clarified filtering options with explicit mention of IN and NOT_IN operators for pull requests and labels.
docs/changelog.md Added July 17, 2025 entry describing exclusion filters (NOT_IN), "Next Steps" section in daily standup reports, CI/CD GitHub Action check status integration, and score card custom report option.

Poem

In the warren of docs, new details appear,
CI/CD checks now crystal clear!
With IN and NOT_IN, filters abound,
Custom and scheduled reports are sound.
Rabbits rejoice, the guide’s up to date—
Hop on, dear devs, and automate!
🐇✨

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • CIRCLECI integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.
📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 86b8187 and 473439c.

📒 Files selected for processing (2)
  • docs/changelog.md (1 hunks)
  • docs/guides/custom-reports.md (3 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/guides/custom-reports.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/changelog.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/report-new-data
🪧 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 auto-generate unit tests to generate unit tests 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.

@alexcoderabbitai alexcoderabbitai enabled auto-merge (squash) July 17, 2025 17:43
@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Jul 17, 2025 •
edited
Loading

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 473439c
Status: ✅  Deploy successful!
Preview URL: https://60ebbee1.coderabbit-docs.pages.dev
Branch Preview URL: https://feat-report-new-data.coderabbit-docs.pages.dev

View logs

@alexcoderabbitai alexcoderabbitai enabled auto-merge (squash) July 17, 2025 18:23
@alexcoderabbitai alexcoderabbitai merged commit d3f45f6 into main Jul 17, 2025
4 checks passed
@alexcoderabbitai alexcoderabbitai deleted the feat/report-new-data branch July 17, 2025 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@alexcoderabbitai