Skip to content

Auto create Markdown based hook docs with pre-commit#12084

Draft
jbampton wants to merge 2 commits intoapache:mainfrom
jbampton:autocreate-hook-docs-pre-commit
Draft

Auto create Markdown based hook docs with pre-commit#12084
jbampton wants to merge 2 commits intoapache:mainfrom
jbampton:autocreate-hook-docs-pre-commit

Conversation

@jbampton
Copy link
Member

Using a local hook and a Python script we can auto create a Markdown page with pre-commit hook docs.

Description

This PR...

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Using a local hook and a Python script we can auto create a Markdown page with pre-commit hook docs.
@boring-cyborg boring-cyborg bot added component:integration Python Warning... Python code Ahead! labels Nov 14, 2025
@codecov
Copy link

codecov bot commented Nov 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 18.02%. Comparing base (b744824) to head (285bd9f).

Additional details and impacted files
@@            Coverage Diff            @@
##               main   #12084   +/-   ##
=========================================
  Coverage     18.02%   18.02%           
  Complexity    16450    16450           
=========================================
  Files          5968     5968           
  Lines        537086   537086           
  Branches      65961    65961           
=========================================
  Hits          96819    96819           
  Misses       429347   429347           
  Partials      10920    10920           
Flag Coverage Δ
uitests 3.53% <ø> (ø)
unittests 19.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:integration Python Warning... Python code Ahead!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant