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

Replace isort quality check #423

Open
jesperhodge opened this issue Jun 13, 2024 · 1 comment
Open

Replace isort quality check #423

jesperhodge opened this issue Jun 13, 2024 · 1 comment

Comments

@jesperhodge
Copy link
Member

jesperhodge commented Jun 13, 2024

Problem Description

Spending two hours to figure out why the CI quality pipeline fails due to how isort wants me to sort my inputs is a waste of time.

isort is not documented in the readme so there's no way to know that you can locally run the command to automatically sort the imports correctly.

The rules are also not clear.

This costs development time.

Solution

Ideally, just run isort in the pipeline automatically and autofix instead of checking, then include the change in the commit.
Or just remove isort from the quality check. Import sorting is not worth the amount of time it costs to fix problems.

@timmc-edx
Copy link
Contributor

Auto-fixing as a GHA sounds nice, but we're probably going to approach this as a docs issue rather than a tooling issue—there's a broader issue of our tools varying somewhat from repo to repo.

In this case, you can run isort locally by using make quality from a virtualenv. More generally, you can run isort directly on a given file (again from a virtualenv) to have it autofix the file locally for you.

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