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

Ensure Ruff checks formatting during CI checks #342

Merged
merged 3 commits into from
Dec 13, 2024

Conversation

whabanks
Copy link
Contributor

Summary | Résumé

  • Updated Ruff to 0.8.2.
  • Updated Ruff VScode extension to prevent automatic removal of unused imports on save. Unused imports will still be removed when make format is ran.
  • Ruff will now properly check formatting in CI.

Test instructions | Instructions pour tester la modification

  1. Dev container builds
  2. Open any python file and add an unused import from app import celery for example
  3. Save the file
  4. Note that the unused import was not removed and that the imports are highlighted indicating a linter error.
  5. Run make format
  6. Note that the unused import was removed.

Reviewer checklist | Liste de vérification du réviseur

  • This PR does not break existing functionality.
  • This PR does not violate GCNotify's privacy policies.
  • This PR does not raise new security concerns. Refer to our GC Notify Risk Register document on our Google drive.
  • This PR does not significantly alter performance.
  • Additional required documentation resulting of these changes is covered (such as the README, setup instructions, a related ADR or the technical documentation).

⚠ If boxes cannot be checked off before merging the PR, they should be moved to the "Release Instructions" section with appropriate steps required to verify before release. For example, changes to celery code may require tests on staging to verify that performance has not been affected.

whabanks and others added 3 commits December 6, 2024 13:13
- The VSCode ruff extension will no longer
automatically remove unused imports but will still
notify you they're incorrect
- Updated ruff to 0.8.2
@whabanks whabanks merged commit 568d873 into main Dec 13, 2024
4 checks passed
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.

2 participants