Skip to content

docs: exclude docs directory from pre-commit hook#10140

Merged
mendonk merged 3 commits into
mainfrom
dont-run-detect-secrets-in-docs-folder
Oct 7, 2025
Merged

docs: exclude docs directory from pre-commit hook#10140
mendonk merged 3 commits into
mainfrom
dont-run-detect-secrets-in-docs-folder

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Oct 6, 2025

Exclude the docs/ directory from the detect-secrets hook, because it blocks commits and pollutes code samples if you need to add # pragma: allowlist secret.

Summary by CodeRabbit

  • Chores
    • Updated secret scanning configuration to exclude the documentation directory, reducing false positives and speeding up pre-commit checks for contributors.
    • Improves developer workflow without affecting application behavior or user-facing functionality.
    • No changes to features, performance, or compatibility for end-users.

@mendonk mendonk requested a review from ogabrielluiz October 6, 2025 18:54
@mendonk mendonk self-assigned this Oct 6, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 6, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Updated .pre-commit-config.yaml to configure the detect-secrets hook to exclude the docs/ directory from scanning by adding an exclude pattern.

Changes

Cohort / File(s) Summary of changes
Pre-commit hooks
.\pre-commit-config.yaml
Added detect-secrets hook configuration to exclude docs/ via exclude: ^docs/.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

lgtm

Suggested reviewers

  • mfortman11
  • aimurphy

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Excessive Mock Usage Warning ❓ Inconclusive No test files were added or modified in this pull request, so there is no new or changed test code to evaluate for excessive mock usage, and existing repository tests remain outside the scope of this check. Because no tests were touched, I cannot assess mock usage for this change; if there are specific test files of concern, please reference them or include related modifications so they can be reviewed.
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title concisely and clearly summarizes the main change of excluding the docs directory from the pre-commit detect-secrets hook, matching the content of the changeset without any noise or ambiguity.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Test Coverage For New Implementations ✅ Passed The PR only updates the detect-secrets configuration to exclude the docs directory and does not introduce new functionality or bug fixes, so no additional tests are required or expected; confirming the change shows no test files were added, but this is acceptable because there is nothing new to cover.
Test Quality And Coverage ✅ Passed The PR only updates the pre-commit configuration by excluding the docs/ directory from detect-secrets scanning and does not introduce or modify runtime code or tests, so no new functionality requires coverage. Because no behavioral changes exist, there is nothing new to exercise through automated tests, and the project’s existing testing strategy remains unaffected. Therefore the test quality and coverage standards for this change are inherently satisfied.
Test File Naming And Structure ✅ Passed No test files were added or modified in this pull request, and the existing backend and frontend test suites already adhere to the required naming patterns and structure with pytest-style test_*.py files and Playwright-focused *.test.ts/tsx files organized under their respective directories; integration tests are appropriately labeled and include meaningful, descriptive scenarios that cover both positive and negative paths with proper setup and teardown. Accordingly, the current change—limited to the pre-commit configuration—does not impact test organization or coverage expectations.

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 6, 2025
@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Oct 6, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 6, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 7, 2025
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Oct 7, 2025

@mendonk mendonk added this pull request to the merge queue Oct 7, 2025
Merged via the queue into main with commit 6a2b013 Oct 7, 2025
16 checks passed
@mendonk mendonk deleted the dont-run-detect-secrets-in-docs-folder branch October 7, 2025 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants