P20WCommunityOfInnovation / DAR-T

Apache License 2.0
3 stars 0 forks source link

Added a linter and formatter to the Github Actions workflow #72

Closed VT-AOE-DMAD-Drew-Bennett closed 9 months ago

sethltaylor commented 9 months ago

@VT-AOE-DMAD-Drew-Bennett Just made a few small changes.

Black is intentionally uncompromising in its formatting so we could also skip the formatting or make it trigger just on a push to main so we don't deal with the formatter during development. We're never going to have the same level of formatting by hand as Black does, so I think our choice is really to either let Black autoformat on push to main or not use it.

VT-AOE-DMAD-Drew-Bennett commented 9 months ago

@VT-AOE-DMAD-Drew-Bennett Just made a few small changes.

  • Updated the action to run on pull request and push to develop as well so we can catch errors earlier.
  • Added some arguments so black would show us what the difference in how it would format in the GH actions log.
  • Minor change to make sure our version of Python is the same across our CI/CD.

Black is intentionally uncompromising in its formatting so we could also skip the formatting or make it trigger just on a push to main so we don't deal with the formatter during development. We're never going to have the same level of formatting by hand as Black does, so I think our choice is really to either let Black autoformat on push to main or not use it.

Sounds good. I might comment out the yml and push so we can merge the two branches together once we figure out #65.

sethltaylor commented 9 months ago

@VT-AOE-DMAD-Drew-Bennett Just made a few small changes.

  • Updated the action to run on pull request and push to develop as well so we can catch errors earlier.
  • Added some arguments so black would show us what the difference in how it would format in the GH actions log.
  • Minor change to make sure our version of Python is the same across our CI/CD.

Black is intentionally uncompromising in its formatting so we could also skip the formatting or make it trigger just on a push to main so we don't deal with the formatter during development. We're never going to have the same level of formatting by hand as Black does, so I think our choice is really to either let Black autoformat on push to main or not use it.

Sounds good. I might comment out the yml and push so we can merge the two branches together once we figure out #65.

Added a line so black only runs on a push to main so we should be good now.