Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre-Commit Hook Setup Issues and Version Mismatch in README #78

Closed
dxvidparham opened this issue Sep 13, 2024 · 2 comments
Closed

Pre-Commit Hook Setup Issues and Version Mismatch in README #78

dxvidparham opened this issue Sep 13, 2024 · 2 comments

Comments

@dxvidparham
Copy link

Issue Summary:

The pre-commit hook setup outlined in the README.md does not work as expected due to two issues:

Version Mismatch: The README.md references version V24.4.0, but the latest available release is V24.3.0. This causes a version not found error during setup.

Missing .pre-commit-hooks.yaml File: After resolving the version issue, running the pre-commit hook results in an error stating that .pre-commit-hooks.yaml is not a valid file, preventing the hook from functioning correctly.

Steps to Reproduce:

Follow the pre-commit hook setup instructions in the README.md.
Attempt to run the pre-commit hook.

Expected Behavior:

The pre-commit hook should run successfully without errors.
The README.md should reference the correct version of the release.

Actual Behavior:

A version not found error occurs due to the README.md referencing a non-existent version (V24.4.0).
After resolving the version mismatch, running the pre-commit hook produces an error related to a missing .pre-commit-hooks.yaml file.

Suggested Fix:

Update the README.md to reflect the correct latest version (V24.3.0 or update to V24.4.0 if that release is imminent).
Ensure that .pre-commit-hooks.yaml is included in the repository or provide instructions for resolving the missing file issue.
@JelleZijlstra
Copy link
Owner

I just released version 24.9.0 and updated the instructions in the README to reference that version. Does this work for you?

@dxvidparham
Copy link
Author

Yes, now everything works as suggested. Thanks!

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

No branches or pull requests

2 participants