Adding flake8, pytest, tox, and github actions #59
Conversation
There was a problem hiding this comment.
I have no clue how to do it with tox, but the pre-commit checks (declared in .pre-commit-config.yaml) should also be run in CI.
.github/workflows/tests.yaml
Outdated
| - uses: actions/checkout@v2 | ||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v2 |
There was a problem hiding this comment.
You should upgrade to the latest version of these actions. These versions rely on some outdated dependencies that GitHub is likely going to be removing from their runners soon.
There was a problem hiding this comment.
Gotcha. Should have used a more up to date tutorial 😭
There was a problem hiding this comment.
Just to clarify, do you mean I should use v4 instead of v2?
There was a problem hiding this comment.
Okay things should be good now. Now i just need to get the tests passing lol
There was a problem hiding this comment.
Just to clarify, do you mean I should use v4 instead of v2?
The latest version of setup-python is actually v5. v4 uses a newer but still EOL version of Node.
There was a problem hiding this comment.
Oh okay. I thought I saw v4 in the docs.
|
For some reason when I run the tests, the pre-commit fails on windows, but not linux. All the other tests pass. Not sure what's up. |
I was one of the people who worked on adding pre-commit, and both of us use Macs as dev machines, so we never encountered the problem on Windows. If you want help, you need to post the error. You can use the instructions on Organizing information with collapsed sections - GitHub Docs to include the error without it taking up too much space. Without you saying anything, I suspect that your problem is with |
Yes you're exactly right. I've been looking at it for the past little while. Sorry @aphedges ! I need to actually do a good hard look before posting. I went ahead and fixed the issue with mixed-line-endings, and now there's an issue with shellcheck. I'm taking a look at it now. |
|
Apparently shellcheck only works on linux when run through github actions. Not sure what to do about that. I'd like to tell it to run pre-commit with (SKIP=shellcheck) if it's running on windows and just precommit if on linux, but I can't seem to find a good way to do that. |
|
This fix looks like it will work: actions/checkout#135. That way, you don't need to change |
@aphedges That worked. Thank you! Sorry I couldn't figure that out myself. |
|
Okay, I think this is everything good now. I went ahead and added mac-os support to testing. I'll open up another PR to get rid of the deprecated methods in the example programs. |
|
Looks good to me. I see all tests are passing on your repo's actions. Should be good. 👍 |
As the title says.
Never worked with any of these technologies, so this is an amalgamation of various tutorials. It works fine on my branch, but I wouldn't necessarily take me at my word here.
Currently we fail flake8 pretty badly right now, but we can deal with that in another PR. This finishes up the list of objectives we had in #54. I feel content closing the issue once we actually start passing flake8, which I can get done when it isn't 1:30 am.