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

Project clean up and maintenance #11

Merged
merged 10 commits into from
Aug 8, 2024

Conversation

chuckwondo
Copy link
Contributor

@francium, this fixes #10.

Aside from updating the versions of the github actions in ci.yml, I did a bit of closely related cleanup/unification as well, but hopefully there aren't too many changes for your liking in this single PR:

  • Add dependabot to autocheck for new github action releases on monthly basis
  • Add Python 3.12 to test matrix
  • Add missing lazydocs dependency, thus allowing make docs to succeed
  • Fix lint-flake to work across all supported python versions (eliminating need for lint-flake-pre310)
  • Combine python deps caching into setup-python action
  • Ignore pip's "root user" warnings so they no longer appear in build output
  • Allow python pre-3.10 code to be type checked without requiring full duplication of yml file
  • Provide more comprehensive "ignore" coverage in .gitignore by leveraging https://www.toptal.com/developers/gitignore/api
  • Allow tox to behave properly with pytest coverage
  • Fix a couple of docstring typos
  • Lint README.md

Please let me know if I've gone a bit overboard here, but these are all (other than typo fixes and markdown linting) related to improving the build process and test coverage.

Also, sort dependencies because I'm a neat freak.
When running coverage using Python < 3.10, we don't want to see the
warnings about being unable to parse code that uses the `match`
construct introduce in Python 3.10.

In addition, remove `--cov=tests` because coverage is meant to measure
only how much of the _main_ code is covered during test execution, not
how much _test_ code is covered.

Lastely, change `term` to `term-missing` to identify _exactly_ which
lines of code are not covered by tests.
Also, replace explicit check for `VIRTUAL_ENV` with `pip`'s
`--require-virtualenv` flag in `install` recipe.
In addition:

- Add python 3.12 to matrix
- Fold dependency caching config into setup-python action
- Ignore root user warnings from pip
- Allow type checks to run on pre-3.10 code without file duplication
Also, exclude `.venv/` from `flake8` coverage for those who prefer to
use that instead of `venv/` for virtualenvs.
@chuckwondo chuckwondo mentioned this pull request Aug 7, 2024
@francium francium merged commit 10e3cf2 into rustedpy:master Aug 8, 2024
5 checks passed
@francium francium changed the title Update GitHub actions Project clean up and maintenance Aug 8, 2024
@francium
Copy link
Member

francium commented Aug 8, 2024

Thank you. Best to break up into smaller and more focused PRs in future though.

@chuckwondo chuckwondo deleted the update-github-actions branch August 16, 2024 10:09
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.

Update github actions
2 participants