Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change the auto-formatting mechanism #322

Closed
laurentheirendt opened this issue Jun 9, 2021 · 6 comments
Closed

change the auto-formatting mechanism #322

laurentheirendt opened this issue Jun 9, 2021 · 6 comments
Assignees
Labels
quality improves maintainability and code clarity

Comments

@laurentheirendt
Copy link
Member

Instead of the current mechanism of auto-formatting, the idea is to:

  • have @cylon-x comment on each new PR/state change whether there is code formatting required
  • before the PR gets merged, a repo maintainer can trigger formatting by commenting: @cylon-x format
  • the bot @cylon-x will the open a new PR against that branch from which it got triggered with a formatting commit

@exaexa I hope that is along those lines what we discussed.

This will also solve #315

@laurentheirendt laurentheirendt added this to the Release - v1.1 milestone Jun 9, 2021
@laurentheirendt laurentheirendt self-assigned this Jun 9, 2021
@exaexa
Copy link
Collaborator

exaexa commented Jun 10, 2021

@exaexa I hope that is along those lines what we discussed.

Yeah sounds perfect. Not sure how complicated it would be to have a "rolling overview comment" that summarizes the latest state of the formatting there, like codecov does with coverage, but it would be really cool.

@exaexa exaexa added the quality improves maintainability and code clarity label Aug 4, 2021
@exaexa
Copy link
Collaborator

exaexa commented Oct 13, 2021

I'm pretty much okay with the current version, given it's totally non-intrusive and really makes the contributors to check their code. Moreover the volume of this might almost be a separate proect. Can we move on here?

@laurentheirendt
Copy link
Member Author

would be nice to have @cylon-x format though 😄 ...

@exaexa exaexa removed this from the Release - v1.1 milestone Oct 28, 2021
@exaexa
Copy link
Collaborator

exaexa commented Apr 29, 2022

@laurentheirendt let's push this a bit. I have some autoformatting ready at https://github.com/exaexa/ci-format-test , also working at #599 . That implements both the new "format by comment", and "format check" as we have now. Uses only github actions. Is there a way to port that to cylon? Or perhaps, don't we want to keep cylon lightweight and instead have this done by a simple github action? (I can publish this as github action at the action market.)

@laurentheirendt
Copy link
Member Author

The action would be triggered automatically, right?

@exaexa
Copy link
Collaborator

exaexa commented Jul 26, 2022

Actually solved in #615

@exaexa exaexa closed this as completed Jul 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
quality improves maintainability and code clarity
Projects
None yet
Development

No branches or pull requests

2 participants