feat: standardize config naming, add optional issue creation for PRs

[myakove]

• Standardize all config keys from underscores to hyphens for consistency
  • webhook_ip → webhook-ip, branch_protection → branch-protection
  • slack_webhook_url → slack-webhook-url, verified_job → verified-job
• Add create-issue-for-new-pr configuration option (default: true)
  • Global and repository-level configuration support
  • Controls whether tracking issues are created for new pull requests
  • Updated welcome messages to reflect the setting
• Update schema, code, tests, examples, and documentation
• Fix type annotation issues in github_repository_settings.py

This improves maintainability with consistent naming and provides users
control over issue creation behavior for new pull requests.

Summary by CodeRabbit

• New Features

  • Added support for a new configuration option to control automatic issue creation for new pull requests.

• Bug Fixes

  • Fixed inconsistent naming of configuration keys by standardizing from underscores to hyphens across all configuration files, documentation, and user-facing messages.

• Documentation

  • Updated documentation to reflect new configuration key naming conventions and document the new issue creation option.

• Tests

  • Enhanced and added tests to verify correct handling of the new configuration option and updated key names.

[coderabbitai]

Warning

Rate limit exceeded

@myakove-bot has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 54 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 64c894c and 17e1f1d.

📒 Files selected for processing (14)

• README.md (3 hunks)
• examples/.github-webhook-server.yaml (3 hunks)
• examples/config.yaml (5 hunks)
• webhook_server/config/schema.yaml (5 hunks)
• webhook_server/libs/github_api.py (2 hunks)
• webhook_server/libs/pull_request_handler.py (3 hunks)
• webhook_server/tests/manifests/config.yaml (2 hunks)
• webhook_server/tests/test_branch_protection.py (3 hunks)
• webhook_server/tests/test_config_schema.py (14 hunks)
• webhook_server/tests/test_pull_request_handler.py (1 hunks)
• webhook_server/tests/test_schema_validator.py (6 hunks)
• webhook_server/tests/test_webhook.py (2 hunks)
• webhook_server/utils/github_repository_settings.py (2 hunks)
• webhook_server/utils/webhook.py (1 hunks)

Walkthrough

Configuration key naming conventions are standardized from underscore_case to kebab-case throughout documentation, schema, configuration files, code, and tests. A new boolean configuration option, create-issue-for-new-pr, is introduced to control automatic issue creation for new pull requests, with corresponding logic, documentation, and test coverage added.

Changes

Files/Paths	Change Summary
README.md, examples/config.yaml, examples/.github-webhook-server.yaml	Updated documentation and example configs: renamed keys to kebab-case, added create-issue-for-new-pr option.
webhook_server/config/schema.yaml	Renamed schema properties to kebab-case; added create-issue-for-new-pr globally and per repository.
webhook_server/libs/github_api.py, webhook_server/libs/pull_request_handler.py	Updated config loading and logic to use kebab-case keys; implemented logic for create-issue-for-new-pr toggle.
webhook_server/utils/github_repository_settings.py, webhook_server/utils/webhook.py	Fixed key names in function logic and lookups to kebab-case.
webhook_server/tests/test_branch_protection.py, webhook_server/tests/test_config_schema.py, webhook_server/tests/test_schema_validator.py, webhook_server/tests/test_webhook.py	Updated test fixtures and assertions to kebab-case keys; added tests for new config option.
webhook_server/tests/manifests/config.yaml	Renamed config keys to kebab-case in test manifests.
webhook_server/tests/test_pull_request_handler.py	New test module for PR issue creation logic covering various configuration scenarios.

Possibly related issues

• feat: standardize config naming, add optional issue creation for PRs - 802 #803: The changes directly address standardizing configuration key naming and adding the optional PR issue creation feature described in this issue.

Suggested labels

size/M

Suggested reviewers

• rnetser

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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>, 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 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.

[myakove-bot]

Report bugs in Issues

Welcome! 🎉

This pull request will be automatically processed with the following features:

🔄 Automatic Actions

• Reviewer Assignment: Reviewers are automatically assigned based on the OWNERS file in the repository root
• Size Labeling: PR size labels (XS, S, M, L, XL, XXL) are automatically applied based on changes
• Issue Creation: A tracking issue is created for this PR and will be closed when the PR is merged or closed
• Pre-commit Checks: pre-commit runs automatically if .pre-commit-config.yaml exists
• Branch Labeling: Branch-specific labels are applied to track the target branch
• Auto-verification: Auto-verified users have their PRs automatically marked as verified

📋 Available Commands

PR Status Management

• /wip - Mark PR as work in progress (adds WIP: prefix to title)
• /wip cancel - Remove work in progress status
• /hold - Block PR merging (approvers only)
• /hold cancel - Unblock PR merging
• /verified - Mark PR as verified
• /verified cancel - Remove verification status

Review & Approval

• /lgtm - Approve changes (looks good to me)
• /approve - Approve PR (approvers only)
• /assign-reviewers - Assign reviewers based on OWNERS file
• /assign-reviewer @username - Assign specific reviewer
• /check-can-merge - Check if PR meets merge requirements

Testing & Validation

• /retest tox - Run Python test suite with tox
• /retest build-container - Rebuild and test container image
• /retest python-module-install - Test Python package installation
• /retest pre-commit - Run pre-commit hooks and checks
• /retest conventional-title - Validate commit message format
• /retest all - Run all available tests

Container Operations

• /build-and-push-container - Build and push container image (tagged with PR number)
  • Supports additional build arguments: /build-and-push-container --build-arg KEY=value

Cherry-pick Operations

• /cherry-pick <branch> - Schedule cherry-pick to target branch when PR is merged
  • Multiple branches: /cherry-pick branch1 branch2 branch3

Label Management

• /<label-name> - Add a label to the PR
• /<label-name> cancel - Remove a label from the PR

✅ Merge Requirements

This PR will be automatically approved when the following conditions are met:

1. Approval: /approve from at least one approver
2. LGTM Count: Minimum 1 /lgtm from reviewers
3. Status Checks: All required status checks must pass
4. No Blockers: No WIP, hold, or conflict labels
5. Verified: PR must be marked as verified (if verification is enabled)

📊 Review Process

Approvers and Reviewers

Approvers:

• @myakove
• @rnetser

Reviewers:

• @myakove
• @rnetser

Available Labels

• hold
• verified
• wip
• lgtm
• approve

💡 Tips

• WIP Status: Use /wip when your PR is not ready for review
• Verification: The verified label is automatically removed on each new commit
• Cherry-picking: Cherry-pick labels are processed when the PR is merged
• Container Builds: Container images are automatically tagged with the PR number
• Permission Levels: Some commands require approver permissions
• Auto-verified Users: Certain users have automatic verification and merge privileges

For more information, please refer to the project documentation or contact the maintainers.

[myakove]

/verified

[myakove-bot]

New container for ghcr.io/myk-org/github-webhook-server:latest published