Add version to github action (and rewrite the whole thing while at it)
#1940
Conversation
stefanfoulis
force-pushed
the
feature/allow-overriding-black-version-in-github-action
branch
from
9e58dce
to
8af883a
Compare
|
@stefanfoulis are you still working on this? No worries if you are no longer so, just checking in. |
stefanfoulis
force-pushed
the
feature/allow-overriding-black-version-in-github-action
branch
from
da50fbb
to
55a46b8
Compare
|
@ichard26 I made some changes to make the tests pass. I suppose we should also add some tests, but I don't know how to test github actions with multiple configurations. |
|
@stefanfoulis thanks! I'll take a look eventually (disclaimer: "eventually" may take a while!). For the testing, I usually just use a spare GitHub repository to test in (e.g. https://github.com/ichard26/testblackaction) but I've heard of https://github.com/nektos/act which allows you to run GHA workflows locally (can't say if it's any good since I haven't used it, but it looks promising at a few quick glances!). |
|
FYI, I'll take over and push this PR to completion @stefanfoulis, thanks for the initial work! |
|
I've hacking on this and I just realized that since now this is a composite action, dependency clashes are possible between Black's dependencies and whatever is installed by the rest of the containing workflow. While a composite action does mean this action can be used on any OS and doesn't require a hacky workaround (and I don't even know if that works), the lack of isolation might be an issue (dependencies clashes, requires the host to have Python 3.6+ as the python pip is attached to). @cooperlees WDYT? |
Maybe make a venv for black so we can never have dependency clashes? |
ichard26
force-pushed
the
feature/allow-overriding-black-version-in-github-action
branch
from
bcc22fe
to
c27ccb4
Compare
ichard26
force-pushed
the
feature/allow-overriding-black-version-in-github-action
branch
from
16223d3
to
4e246d8
Compare
…iding-black-version-in-github-action
Since we're moving to a composite based action, quite a few changes were made. 1) Support was added for all OSes (Windows was painful). 2) Isolation from the rest of the workflow had to be done manually with a virtual environment. Other noteworthy changes: - Rewrote basically all of the logic and put it in a Python script for easy testing (not doing it here tho cause I'm lazy and I can't think of a reasonable way of testing it). - Renamed `black_version` to `version` to better fit the existing input naming scheme. - Added support for log groups, this makes our action's output a bit more fancy (I may or may have not added some debug output too).
Reflect compatability and gotchas.
ichard26
force-pushed
the
feature/allow-overriding-black-version-in-github-action
branch
from
4e246d8
to
4881c7b
Compare
|
Example runs:
|
ichard26
changed the title
version to github action (and rewrite the whole thing while at it)
|
Thanks @JelleZijlstra and @cooperlees for the reviews, they are super appreciated :) Hopefully this is ready to go now @cooperlees! |
|
Thank you @stefanfoulis so much! While I may have been the person to push this to completion, without your initial work, I don't think we would've ever worked on this feature (or atleast for a quite a while!). I'm so happy with the end result, much better usability now. If you have any cycles to spare, it would be great if you could provide some feedback from your experience contributing to psf/black, more details here: #2238. Thank you once again! |
Allows setting the exact black version use with the github action.
This is useful to be able to avoid needing to deal with black formatting changes introduced in new black versions in unrelated pull-requests.