<div dir="auto"><div><br><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Sep 2, 2020, 5:51 PM Chris Johns <<a href="mailto:chrisj@rtems.org">chrisj@rtems.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On 3/9/20 7:39 am, Gedare Bloom wrote:<br>
> On Wed, Sep 2, 2020 at 2:00 PM Mritunjay Sharma<br>
> <<a href="mailto:mritunjaysharma394@gmail.com" target="_blank" rel="noreferrer">mritunjaysharma394@gmail.com</a>> wrote:<br>
>><br>
>> Hello everyone!<br>
>><br>
>> After recently seeing the Python Development<br>
>> guidelines for RTEMS, I found that<br>
>> "RTEMS Tools should be piped through the yapf Python code<br>
>> formatter before it is committed or sent for review."<br>
>><br>
>> This gave me an idea to build something that can automate<br>
>> this process and take the pressure off both from<br>
>> Maintainers as well as Contributors.<br>
>><br>
>> I am pleased to tell you that I have successfully implemented this<br>
>> idea by building an open-source GitHub action called 'autoyapf'.<br>
>><br>
>> Link to the tool is: <a href="https://github.com/marketplace/actions/autoyapf" rel="noreferrer noreferrer" target="_blank">https://github.com/marketplace/actions/autoyapf</a><br>
>> Link to the github repo: <a href="https://github.com/mritunjaysharma394/autoyapf" rel="noreferrer noreferrer" target="_blank">https://github.com/mritunjaysharma394/autoyapf</a><br>
>><br>
>> What it does is that whenever a maintainer pushes a python code in the repo<br>
>> or merges a PR of a contributor containing Python code, autoyapf action is<br>
>> triggered and it automatically checks if the file is piped in 'yapf' format or not<br>
>> and if not then it will automatically commit the changes in concerned file<br>
>> to make it follow the PEP 8 style guide using yapf.<br>
>><br>
> <br>
> Interesting concept. I think this would be more useful a bit earlier<br>
> in the development pipeline though. What about as a pre-commit<br>
> githook?<br>
<br>
It is interesting and I like the idea of some support but we are not a github<br>
hosted project so workflows will not work for us. Plus at the moment the repos I<br>
am interested in need to be converted to yapf for any support like this to work.<br>
The yapf changes are not too bad, the pylint changes, which are worth doing,<br>
take a lot longer.<br>
<br>
I am running `yapf -i myfile.py` before I create the commit. This way I check<br>
the changes as part of a review before creating the commit.<br>
<br>
Could the precommit hook simply stop the commit and force you to run yapf if<br>
there is a required change? Would this require you have yapf installed?<br></blockquote></div></div><div dir="auto"><br></div><div dir="auto"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"></blockquote></div></div><div dir="auto">I think I would be ok with this behaviour. Whatever free checkers we use should be no problem to expect someone to have and run. </div><div dir="auto"><br></div><div dir="auto">We just have to be clean first. :)</div><div dir="auto"><br></div><div dir="auto">--joel</div><div dir="auto"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Chris<br>
_______________________________________________<br>
devel mailing list<br>
<a href="mailto:devel@rtems.org" target="_blank" rel="noreferrer">devel@rtems.org</a><br>
<a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer noreferrer" target="_blank">http://lists.rtems.org/mailman/listinfo/devel</a><br>
</blockquote></div></div></div>