feat(bb:pr:create): Ability to override PR Title and Description

[psadi]

Default PR Title & Description can be overridden as part PR creation, if empty defaults to existing values from the commit header and body

Summary by CodeRabbit

• New Features
  • Added optional parameters for custom title and description when creating pull requests, enhancing contextual clarity.
• Bug Fixes
  • Improved usability by separating title and description inputs in multiple functions, reducing potential confusion.
• Chores
  • Updated documentation to reflect changes in function parameters and improve clarity for users.
  • Upgraded the pre-commit package version to enhance the development workflow.
  • Added a .gitignore entry to ignore test-related files and directories for a cleaner repository.

[coderabbitai]

Walkthrough

This update enhances the pull request creation process by introducing distinct parameters for titles and descriptions, promoting clarity and usability. Multiple functions across various modules have been modified to handle these parameters separately, ensuring a more intuitive interface. Additionally, the .gitignore file now ignores test directories, and the requirements.txt file has been upgraded to a newer version of the pre-commit package, which may improve the overall development workflow.

Changes

File	Change Summary
.gitignore	Added a line to ignore any test directories or files.
bb/pr/__init__.py, bb/pr/create.py	Introduced title and description parameters to relevant functions for better pull request context and clarity.
bb/utils/api.py	Modified pull_request_body to accept distinct title and description parameters instead of a combined one.
bb/utils/helper.py	Enhanced validate_input function by adding default and optional parameters for improved input handling.
requirements.txt	Upgraded pre-commit from version 3.7.1 to 3.8.0.
tests/props.py, tests/test_api.py	Updated tests to reflect changes in the Api class, separating title and description attributes, and modifying assertions accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PR_API
    participant Utils

    User->>PR_API: create(title, description)
    PR_API->>Utils: pull_request_body(title, description)
    Utils-->>PR_API: formatted_body
    PR_API-->>User: return formatted pull request

Loading

Poem

In fields of code, a rabbit hops,
With titles bright and no more flops.
Pull requests now, so clear and neat,
Separate words, a thrilling feat!
So let us code, with hearts so light,
For every change brings joy and delight! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ccd125c and d543916.

Files ignored due to path filters (1)

• pdm.lock is excluded by !**/*.lock

Files selected for processing (9)

• .gitignore (1 hunks)
• bb/pr/init.py (4 hunks)
• bb/pr/create.py (5 hunks)
• bb/utils/api.py (3 hunks)
• bb/utils/helper.py (2 hunks)
• bb/utils/richprint.py (1 hunks)
• requirements.txt (1 hunks)
• tests/props.py (1 hunks)
• tests/test_api.py (2 hunks)

Files skipped from review as they are similar to previous changes (8)

• .gitignore
• bb/pr/init.py
• bb/utils/api.py
• bb/utils/helper.py
• bb/utils/richprint.py
• requirements.txt
• tests/props.py
• tests/test_api.py

Additional comments not posted (7)

bb/pr/create.py (7)

42-43: Parameter update: Separate title and description.

The function now takes title and description as separate parameters, improving clarity and usability.

---

54-55: Docstring update: Reflect parameter changes.

The docstring correctly reflects the updated parameters title and description.

---

86-87: Correct usage of new parameters.

The new parameters title and description are correctly used in the table for displaying PR details.

---

95-97: Parameter update: Include title and description.

The function now includes title and description parameters, enhancing flexibility in PR creation.

---

107-108: Docstring update: Reflect parameter changes.

The docstring correctly reflects the updated parameters title and description.

---

129-129: Correct usage of new parameters.

The new parameters title and description are correctly passed to the gather_facts function.

---

136-137: Correct usage of new parameters.

The new parameters title and description are correctly used in the pull_request_body function call.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud