Skip to content

Conversation

@CoMPaTech
Copy link
Owner

@CoMPaTech CoMPaTech commented Jan 12, 2026

Summary by CodeRabbit

  • Chores

    • Version bumped to 0.6.2.
    • CI/development workflow migrated from pre-commit to prek for installing and running hooks, preserving existing checks.
    • Explicit empty additional_dependencies added for the markdown linting hook.
  • Documentation

    • Added changelog entry for 0.6.2 describing the workflow tooling migration.

✏️ Tip: You can customize this high-level summary in your review settings.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jan 12, 2026
@CoMPaTech CoMPaTech added enhancement New feature or request and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Jan 12, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 12, 2026

Warning

Rate limit exceeded

@CoMPaTech has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 9 minutes and 40 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 712be7a and 0c99479.

📒 Files selected for processing (4)
  • .github/workflows/verify.yml
  • .markdownlint.yaml
  • .pre-commit-config.yaml
  • .pymarkdown

Walkthrough

Replaces pre-commit with prek in the verify GitHub Actions workflow, updates environment variable and steps, bumps project version to 0.6.2, adds a changelog entry, and adds an explicit empty additional_dependencies for the markdownlint hook.

Changes

Cohort / File(s) Summary
CI/CD Workflow
​.github/workflows/verify.yml
Replaces pre-commit usage with prek: renames PRE_COMMIT_HOMEPREK_HOME, installs prek (via same requirements), removes pre-commit install steps, adds prek install --install-hooks, renames step to "Full prek (pre-commit)", and runs prek run --show-diff-on-failure --color=always --all-files.
Project Metadata
pyproject.toml
Bumps project version from 0.6.1 to 0.6.2.
Changelog
CHANGELOG.md
Adds [0.6.2] entry (2026-01-12) noting migration from pre-commit to prek under "Changed".
Pre-commit Config
.pre-commit-config.yaml
Adds an explicit empty additional_dependencies: [] for the markdownlint hook.

Sequence Diagram(s)

(omitted — changes are CI/workflow/tooling updates and not suitable for a multi-component runtime sequence diagram)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • Small adjustments #44 — Modifies the same verify workflow step around the pre-commit run; related at the workflow step level.

Poem

🐇 I nudged the hooks and changed the trail,
From pre-commit to prek — a lighter sail.
Version hopped up, changelog in tow,
CI now skips where old winds blow.

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Prek' is extremely vague and does not clearly convey the main change to reviewers. While related to the change (migrating from pre-commit to prek), it lacks specificity and reads as a single tool name rather than a descriptive summary. Revise the title to be more descriptive, such as 'Migrate from pre-commit to prek' or 'Replace pre-commit tooling with prek in CI workflow' to clearly communicate the main change.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch prek

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.

@codecov
Copy link

codecov bot commented Jan 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.07%. Comparing base (093d7b7) to head (0c99479).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #149   +/-   ##
=======================================
  Coverage   87.07%   87.07%           
=======================================
  Files           8        8           
  Lines         743      743           
=======================================
  Hits          647      647           
  Misses         96       96           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jan 12, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/workflows/verify.yml (1)

6-6: Update PRE_COMMIT_HOME to PREK_HOME for consistency with prek.

While prek respects PRE_COMMIT_HOME through compatibility fallbacks, prek uses PREK_HOME (default ~/.cache/prek) as its native cache directory. Update line 6 to PREK_HOME: ~/.cache/prek to align with prek's conventions and make the tooling intent explicit.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 093d7b7 and 44bf57e.

📒 Files selected for processing (3)
  • .github/workflows/verify.yml
  • CHANGELOG.md
  • pyproject.toml
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[grammar] ~9-~9: Ensure spelling is correct
Context: ... ### Changed - Migrated pre-commit to prek ## [0.6.1] - 2026-01-03 ### Added - Provi...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Process test coverage
🔇 Additional comments (3)
CHANGELOG.md (1)

5-9: LGTM!

The changelog entry is correctly formatted, follows the existing style, and accurately documents the migration from pre-commit to prek. The static analysis spelling warning for "prek" is a false positive as it's a tool name.

pyproject.toml (1)

7-7: LGTM!

Version bump to 0.6.2 aligns with the changelog entry and is appropriate for a tooling change (patch version increment).

.github/workflows/verify.yml (1)

78-83: LGTM!

The migration from pre-commit to prek is complete and consistent:

  • Package installation updated correctly
  • Hook installation command updated
  • Run command preserves the same flags (--show-diff-on-failure, --color=always, --all-files)
  • The SKIP=no-commit-to-branch bypass is maintained

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/workflows/verify.yml (1)

74-84: Remove prek install --install-hooks from CI or add explanatory comment if intentional.

The prek install --install-hooks command pre-creates hook environments and installs git hooks, which is not needed for CI hook execution. Standard CI practice is to simply run prek run --all-files without the install step. If this line serves a specific purpose (e.g., pre-warming environments), add a comment clarifying why. All flags (--show-diff-on-failure, --color, --all-files) and SKIP=no-commit-to-branch are fully supported by prek.

🧹 Nitpick comments (1)
.github/workflows/verify.yml (1)

3-7: Document the intentional PREK_HOME override for clarity.

PREK_HOME is deliberately set to ~/.cache/pre-commit rather than prek's documented default (~/.cache/prek). While this likely serves a purpose (cache reuse), add a comment explaining the rationale to prevent confusion for future maintainers. Shell expansion of ~ works as expected in GitHub Actions, so no change needed there.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 44bf57e and d308944.

📒 Files selected for processing (1)
  • .github/workflows/verify.yml

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Jan 12, 2026
@sonarqubecloud
Copy link

@CoMPaTech CoMPaTech merged commit 171cd12 into main Jan 12, 2026
15 checks passed
@CoMPaTech CoMPaTech deleted the prek branch January 12, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants