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

Support venv and use of github actions for contributors #1122

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

MusicalNinjaDad
Copy link

Resolves #1109

The current .gitignore, setup.py and test.yml are focussed on a specific development set up.
These changes support a few additional development setup preferences without breaking anything. (Do no harm):

  • Using pythons venv virtual environments,
  • using editors other than vim
  • debugging (via) tests,
  • leveraging github actions for regression testing,
  • visualising code coverage results on codecov.io

Each of these adjustments do no harm, and are individually committed to allow for cherry-picking if there is something you do not like.

If these changes are not integrated into the main codebase then any PRs raised by someone who has made a similar adjustment to support their environment will either silently include them or need rebasing before raising and then be prone to error due to a large number of changes suddenly being present in working tree, regression testing not executing etc. on the final code included in the PR.

A note on codecov.io - the action will do nothing if the repo is not previously linked, so there is no data uploaded etc. unless the repo owner has specifically set this up in advance. I.e. no harm in the action being present at the end of the pipeline.

@@ -62,7 +62,9 @@ gpiozero_mock_pin_classes =
mocktriggerpin = gpiozero.pins.mock:MockTriggerPin

[tool:pytest]
addopts = -rsx --cov --tb=short
# addopts = -rsx --cov --tb=short
# Uncomment the above line to provide basic coverage information in local runs
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume that this was enabled for a reason, so perhaps it should be left enabled by default? 🤷

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.

First contribution hurdles in .gitignore, workflow, scripts
2 participants