pre-commit prevent commits to protected branches

[seanbudd]

Link to issue number:

None

Summary of the issue:

To help ensure NV Access admins do not accidentally commit and push to master, we can add a pre-commit check to protect branches from local commits.
This would also aid other developers in preventing local commits to branches they cannot/shouldn't push to in their own forks accidentally, if they wish to contribute upstream.

Description of user facing changes

Add pre-commit hook which fails when trying to commit to a protected branch

Description of development approach

Add pre-commit hook which fails when trying to commit to a protected branch

Testing strategy:

Test committing to master after merging the branch locally

Known issues with pull request:

None

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

Summary by CodeRabbit

• New Features

  • Added a new pre-commit hook to prevent commits to critical branches (master, beta, and rc), enhancing branch protection.

• Chores

  • Updated pre-commit hook configuration file to include the new branch protection rule while retaining existing hooks for Python syntax checks.

[coderabbitai]

Walkthrough

The recent update introduces a new pre-commit hook to the configuration, which prevents commits to critical branches like master, beta, and rc. This enhancement safeguards important branches from accidental changes while maintaining existing hooks, such as check-ast, to ensure continued functionality for syntax checks in Python files.

Changes

Files	Change Summary
.pre-commit-config.yaml	Added no-commit-to-branch hook to prevent commits to master, beta, and rc branches; existing hooks remain unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Git
    participant Pre-commit Hook

    Developer->>Git: Attempts to commit changes
    Git->>Pre-commit Hook: Triggers pre-commit hooks
    Pre-commit Hook->>Pre-commit Hook: Checks branch against protected branches
    alt If branch is protected
        Pre-commit Hook-->>Git: Reject commit
        Git-->>Developer: Notify commit failure
    else If branch is not protected
        Pre-commit Hook-->>Git: Allow commit
        Git-->>Developer: Confirm commit success
    end

Loading

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b4831e5 and b8206f2.

Files selected for processing (1)

• .pre-commit-config.yaml (1 hunks)

Additional comments not posted (2)

.pre-commit-config.yaml (2)

Line range hint 20-23:
LGTM! No changes to the existing hook.

The existing hook check-ast remains unchanged and continues to check Python syntax.

---

17-19: LGTM! Verify the pre-commit hook functionality.

The new hook no-commit-to-branch is correctly configured to prevent commits to master, beta, and rc branches.

However, ensure that the pre-commit hook functions as expected by testing it in a local environment.

---

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.

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: License check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/nlsc2cmeqdkd6tlr/artifacts/output/nvda_snapshot_pr16970-33274,5fe8e590.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.0,
  INSTALL_END 1.0,
  BUILD_START 0.0,
  BUILD_END 11.1,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 17.8,
  FINISH_END 0.2

See test results for failed build of commit 5fe8e59075