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

Add codespell gh workflow #2625

Closed
wants to merge 5 commits into from
Closed

Conversation

eapolinario
Copy link
Collaborator

Why are the changes needed?

Typos make the project look unprofessional, so in the same vein as flyteorg/flyte#5418.

What changes were proposed in this pull request?

We added a new gh workflow that only runs the codespell utility as flyteorg/flyte#5418.

I also removed dev-requirements.txt opportunistically, since it's not really used in the repo anywhere.

How was this patch tested?

Ran make spellcheck

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

Signed-off-by: Eduardo Apolinario <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
Copy link

codecov bot commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.34%. Comparing base (085fa9c) to head (3b1f96a).
Report is 2 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #2625       +/-   ##
===========================================
+ Coverage   41.91%   96.34%   +54.42%     
===========================================
  Files         188       28      -160     
  Lines       19037     1449    -17588     
  Branches     3715        0     -3715     
===========================================
- Hits         7980     1396     -6584     
+ Misses      10948       53    -10895     
+ Partials      109        0      -109     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this a precommit hook, so that make lint catches these issue before we push?

https://github.com/codespell-project/codespell?tab=readme-ov-file#pre-commit-hook

Usinga a pre-commit-hook means we can keep the config in pyproject.toml.

@eapolinario
Copy link
Collaborator Author

Can we make this a precommit hook, so that make lint catches these issue before we push?

https://github.com/codespell-project/codespell?tab=readme-ov-file#pre-commit-hook

Usinga a pre-commit-hook means we can keep the config in pyproject.toml.

Good call. This is already a precommit hook. I'm updating the version (and fixing a few typos) in #2630.

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