Skip to content

Fix pre-commit autoupdate workflow by forking one of the hooks#1163

Merged
alexdewar merged 1 commit intomainfrom
fix-pre-commit-autoupdate
Mar 3, 2026
Merged

Fix pre-commit autoupdate workflow by forking one of the hooks#1163
alexdewar merged 1 commit intomainfrom
fix-pre-commit-autoupdate

Conversation

@alexdewar
Copy link
Copy Markdown
Member

@alexdewar alexdewar commented Mar 3, 2026

Description

One of the hooks we are using appears to be unmaintained ([cffconvert]) and there is unfortunately an issue that means that pre-commit autoupdate falls over when it hits this repo. There doesn't appear to be any way to get the GitHub Action we are using to ignore this repo either.

We could just drop the hook, but I think it's useful, so instead I forked it here and made a new release: https://github.com/EnergySystemsModellingLab/cffconvert

Note that I didn't change any code; just making the release is enough to fix the problem.

We can always change back to using the upstream version if someone else takes over maintainership (though the last release was in 2021...).

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc
  • Update release notes for the latest release if this PR adds a new feature or fixes a bug
    present in the previous release

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copilot AI review requested due to automatic review settings March 3, 2026 14:23
@alexdewar alexdewar requested review from Aurashk and tsmbland March 3, 2026 14:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the pre-commit configuration to use a maintained fork of cffconvert, addressing failures in the pre-commit autoupdate workflow caused by the upstream repo being unmaintained.

Changes:

  • Switch validate-cff hook source repo from citation-file-format/cffconvert to EnergySystemsModellingLab/cffconvert.
  • Update the pinned rev from a commit SHA to the fork’s 2.1.0 release tag.

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

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.50%. Comparing base (28dee31) to head (3e63945).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1163   +/-   ##
=======================================
  Coverage   87.50%   87.50%           
=======================================
  Files          57       57           
  Lines        7675     7675           
  Branches     7675     7675           
=======================================
  Hits         6716     6716           
  Misses        657      657           
  Partials      302      302           

☔ 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.

@alexdewar alexdewar added this to MUSE Mar 3, 2026
@alexdewar alexdewar moved this to 👀 In review in MUSE Mar 3, 2026
Copy link
Copy Markdown
Collaborator

@tsmbland tsmbland left a comment

Choose a reason for hiding this comment

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

Annoying, but I'm okay with it

@alexdewar alexdewar merged commit 71710ab into main Mar 3, 2026
12 checks passed
@alexdewar alexdewar deleted the fix-pre-commit-autoupdate branch March 3, 2026 19:35
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in MUSE Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

3 participants