-
Notifications
You must be signed in to change notification settings - Fork 0
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
Set up PR validation #6
Conversation
…ly/setup-automation
…ly/setup-automation
…ly/setup-automation
push: | ||
branches: [ "main" ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is necessary. Nobody will be checking these post-merge actions. The primary goal here is to test PR's and get status feedback before merging.
strategy: | ||
fail-fast: false | ||
matrix: | ||
python-version: ["3.12.2"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lets go ahead and add 13 to the matrix!
python-version: ["3.12.2"] | |
python-version: ["3.12.2", "3.13.1"] |
Closing in favor of this pr |
Summary
Set up the following github actions on PRs:
The actions template I used is based on the recommended one for python packages.
I chose to use ruff for linting because it was popular, simple to setup and mentioned on the github actions documentation.
Right now there's only one unit test in the repo, for
patch_requests
, which we actually don't use right now, but it provided a convenient test case for this PR. I added a comment at the bottom of the script as to how we would run tests in additional folders. We will definitely have more tests in the upcoming neighborhood package.Note: this PR does not have nearly as many lines as it seems. Most of those are auto-generated lines in the build files that can be ignored.
Links
Follow ups
I want to add a linting (and maybe also a run unit tests) pre-commit hook as well, but that work was separate enough that it will be done as a follow-up.