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

Improve usability of Sphinx Lint with pre-commit #94

Merged
merged 5 commits into from
Oct 15, 2023

Conversation

AlexWaygood
Copy link
Collaborator

.pre-commit-hooks.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
.pre-commit-hooks.yaml Outdated Show resolved Hide resolved
.pre-commit-hooks.yaml Outdated Show resolved Hide resolved
Co-authored-by: Hugo van Kemenade <[email protected]>
@AlexWaygood AlexWaygood merged commit dbccac0 into main Oct 15, 2023
33 checks passed
@AlexWaygood AlexWaygood deleted the pre-commit-config branch October 15, 2023 16:50
@hugovk
Copy link
Collaborator

hugovk commented Oct 15, 2023

Shall we release this? As a minor or patch?

@AlexWaygood
Copy link
Collaborator Author

AlexWaygood commented Oct 15, 2023

Could do a minor release! (Not sure it qualifies for a patch release since it's not fixing a regression, really, and there's a small risk that changing the defaults here could itself introduce regressions for users?)

I think it's a useful change. It's also not a crucial change, though, so we could also wait for #87 to be ready. I'm easy either way :)

@AlexWaygood
Copy link
Collaborator Author

Actually, I changed my mind. You're right, this probably does deserve a release on its own. As things stand, the advice in the README on how to use Sphinx Lint with pre-commit is now incorrect if you're using the latest release of Sphinx Lint :)

Do you want to take care of the release, or shall I?

@hugovk
Copy link
Collaborator

hugovk commented Oct 15, 2023

Go for it!

Will be a good test of trusted publishing and the release checklist:

https://github.com/sphinx-contrib/sphinx-lint#releasing

@AlexWaygood
Copy link
Collaborator Author

Success! https://pypi.org/project/sphinx-lint/0.8.0/

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.

3 participants