Skip to content

[CI] Add manual pre-commit hook to validate the dependabot config - #12932

Draft
jbampton wants to merge 2 commits into
apache:mainfrom
jbampton:add-dependabot-validation
Draft

[CI] Add manual pre-commit hook to validate the dependabot config#12932
jbampton wants to merge 2 commits into
apache:mainfrom
jbampton:add-dependabot-validation

Conversation

@jbampton

Copy link
Copy Markdown
Member

https://www.npmjs.com/package/@bugron/validate-dependabot-yaml

refs #12930

Description

This PR adds another check or test to our pre-commit framework.

refs apache/sedona#2793

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?

Ran the manual hooks with pre-commit"

pre-commit run --all-files --hook-stage manual

Ran the standard pre-commit hooks:

pre-commit run --all-files

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

@jbampton

Copy link
Copy Markdown
Member Author

@blueorangutan package

@blueorangutan

Copy link
Copy Markdown

@jbampton a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

@codecov

codecov Bot commented Mar 31, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 19.64%. Comparing base (1ceb1d0) to head (617ad69).

Additional details and impacted files
@@             Coverage Diff              @@
##              main   #12932       +/-   ##
============================================
+ Coverage     3.41%   19.64%   +16.23%     
- Complexity       0    19789    +19789     
============================================
  Files          487     6368     +5881     
  Lines        41867   574889   +533022     
  Branches      7912    70353    +62441     
============================================
+ Hits          1429   112962   +111533     
- Misses       40238   449653   +409415     
- Partials       200    12274    +12074     
Flag Coverage Δ
uitests 3.41% <ø> (ø)
unittests 20.92% <ø> (?)

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

☔ View full report in Codecov by Harness.
📢 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.

@blueorangutan

Copy link
Copy Markdown

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17309

@DaanHoogland

Copy link
Copy Markdown
Contributor

@jbampton , I have found dependabot to be generally useless in this repo (works fine in the website repo). Will this improve the updates as well?

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a manual pre-commit hook to validate the repository’s Dependabot configuration, helping catch invalid .github/dependabot.yml changes before they’re committed.

Changes:

  • Introduces a new local, manual-stage pre-commit hook to validate .github/dependabot.yml via @bugron/validate-dependabot-yaml.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .pre-commit-config.yaml
Comment on lines +38 to +39
entry: npx @bugron/validate-dependabot-yaml@0.3.3
language: system

Copilot AI Mar 31, 2026

Copy link

Choose a reason for hiding this comment

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

Using language: system with an npx ...@0.3.3 entry makes this hook depend on whatever Node/npm/npx happens to be installed on the developer machine (and may not run at all if npx isn’t available/in PATH). To make the manual hook reproducible and cross-platform, configure it as a language: node hook with additional_dependencies: ['@bugron/validate-dependabot-yaml@0.3.3'] and set entry to the installed CLI (so pre-commit manages the Node environment and caching).

Suggested change
entry: npx @bugron/validate-dependabot-yaml@0.3.3
language: system
entry: validate-dependabot-yaml
language: node
additional_dependencies: ['@bugron/validate-dependabot-yaml@0.3.3']

Copilot uses AI. Check for mistakes.
Copilot AI review requested due to automatic review settings August 12, 2026 08:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

.pre-commit-config.yaml:40

  • Using language: system with npx makes this hook depend on a preinstalled Node/npm toolchain and can also trigger an interactive "Ok to proceed?" prompt on some npm/npx versions when the package is not already cached. This can break manual hook runs (and any CI job that runs manual hooks). Consider making npx non-interactive at minimum, or switching to a managed pre-commit environment.
        entry: npx @bugron/validate-dependabot-yaml@0.3.3
        language: system
        files: ^\.github/dependabot\.yml$

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants