Skip to content

Add a lower-bound pin for the flake8-docstrings pip package #184

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

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

jsf9k
Copy link
Member

@jsf9k jsf9k commented Jul 1, 2024

🗣 Description

I noticed that flake8-docstrings is listed as an additional dependency of flake8 in the pre-commit configuration, but pinning is done.

💭 Motivation and context

@mcdonnnj agreed with me that it makes sense to at least perform some minimal pinning to ensure that a working version of flake8-docstrings is installed.

🧪 Testing

All automated tests pass. I also verified that there are no other additional dependencies in the pre-commit configuration that do no at least have a lower-bound pin.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All new and existing tests pass.

@jsf9k jsf9k added dependencies Pull requests that update a dependency file kraken 🐙 This pull request is ready to merge during the next Lineage Kraken release labels Jul 1, 2024
@jsf9k jsf9k marked this pull request as ready for review July 1, 2024 20:24
@jsf9k jsf9k requested a review from a team July 1, 2024 20:24
Previously we only provided a lower bound for the version, but pinning to a specific version aligns with what has been done with the prettier hook and how pre-commit hooks are pinned in general.

The flake8-docstrings package is rarely updated, so there is no real downside to pinning to a specific version.

Co-authored-by: Nick <[email protected]>
@jsf9k jsf9k requested a review from mcdonnnj August 26, 2024 13:28
@mcdonnnj mcdonnnj added this pull request to the merge queue Sep 25, 2024
Merged via the queue into develop with commit e61255c Sep 25, 2024
4 checks passed
@mcdonnnj mcdonnnj deleted the improvement/pin-flake8-docstrings branch September 25, 2024 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file kraken 🐙 This pull request is ready to merge during the next Lineage Kraken release
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants