This repository was archived by the owner on Feb 6, 2025. It is now read-only.
Set up PR validation #6
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ly/setup-automation
…ly/setup-automation
…ly/setup-automation
cat5inthecradle
approved these changes
Dec 10, 2024
Comment on lines
+7
to
+8
| push: | ||
| branches: [ "main" ] |
There was a problem hiding this comment.
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.
lets go ahead and add 13 to the matrix!
Suggested change
| python-version: ["3.12.2"] | |
| python-version: ["3.12.2", "3.13.1"] |
|
Closing in favor of this pr |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.