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

Make reformating easier #2336

Open
markus2330 opened this Issue Jan 25, 2019 · 2 comments

Comments

Projects
None yet
2 participants
@markus2330
Copy link
Contributor

markus2330 commented Jan 25, 2019

The jenkins buildserver runs tests/shell/check_formatting.sh at an early stage but:

  • it might not run all of the formatting checks (cmake-format or shfmt might not be installed)
  • it does not give help how to apply this patch locally
  • it does not give help how to run the checks locally
@kodebach

This comment has been minimized.

Copy link
Contributor

kodebach commented Feb 1, 2019

We could set up a Probot instance on our own server. Probot could react to pull requests similarly to our CI systems. However, Probot would just run our formatting check and in case something is wrong report that using the Checks API. It should also be possible to create a button for automatically reformatting the code in the details tab of the check run.

Alternatively we could use Github Actions which is currently in beta. They are basically Github's native replacement for Probot. I didn't find an example, but at least in theory it should be possible to automatically reformat all commits pushed to the repository. In future, it should also be possible to use the Checks API like described above, however, currently only push events are supported for public repositories.

Both solutions would also eliminate any possible version mismatches of our formatting tools. They would however introduce additional commits, every time something has to be reformatted, so developers should still try to format everything correctly.

Both Github Actions and Probot could be used for many other things. e.g. enforcing the changes to the release notes, automatically labeling PRs or Issues, enforcing certain rules for PR names and commit message, etc.

@markus2330

This comment has been minimized.

Copy link
Contributor Author

markus2330 commented Feb 1, 2019

Thank you for looking into it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment