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

ci: Add annotations, more mypy checks #95

Closed
wants to merge 1 commit into from
Closed

ci: Add annotations, more mypy checks #95

wants to merge 1 commit into from

Conversation

mdeweerd
Copy link
Contributor

@mdeweerd mdeweerd commented Jan 12, 2024

  • Improve caching by also saving cache on failures.
  • Generate github annotations from pre-commit output (need logToCs.py);
  • Install typing dependencies to remove "ignore-missing-imports" on mypy
  • Add mdformat plugins to format code.
  • Ignore test on cygwin
  • Add codespell checks

Note: regarding the annotations, you can have a look in the Files changed tab .
The action summary also has up to 10 error and 10 warning annotations.

Copy link
Owner

@Lucas-C Lucas-C left a comment

Choose a reason for hiding this comment

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

Overall, I really like the idea of logToCs.py to convert pre-commit output into a CheckStyle report, so that they can then be exposed as PR annotations.
Good job on crafting this 👍

However, I am NOT favourable towards adding this ~400 lines Python script to this project.
Its purpose is distinct / larger than the scope of this repository, and I do not wish to maintain it.

It would be better as a standalone project! 🙂
If published on Pypi, or in a dedicated GitHub repo usable as a GA workflow script, it could be reused in several GitHub Actions pipelines! And it could have its own README with explanations and even potentially unit tests.

Again, to be clear: I would gladly consider using this tool if it only introduced a few extra lines in .github/workflows/ci.yml, but I'm sorry I won't merge a PR that introduces hundreds of new lines of Python code that are not directly related to pre-commit hooks.

@mdeweerd
Copy link
Contributor Author

I am not at the step of setting up a package or GA yet - I have set up a project for it though:
https://github.com/mdeweerd/LogToCheckStyle

@mdeweerd mdeweerd closed this by deleting the head repository Jan 15, 2024
@mdeweerd
Copy link
Contributor Author

mdeweerd commented Feb 9, 2024

FYI: https://github.com/mdeweerd/LogToCheckStyle now proposes a Github Action.

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.

None yet

2 participants