ci: Add formatting pre-submit check #3654
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a formatting pre-submit check that runs
make format
and checks for file differences. The results of runningmake format
are not included in this PR for readability. So the pre-submit will depend on #3655 and probably some more formatting before the check will pass.Added a
make shfmt
formatting check for bash scripts.autogen
(for adding license headers) is now vendored in thethird_party
directory for convenience sake.markdown-toc
andautogen
are now run bymake format
. The formatting pre-submit now runs these as well so they don't have separate pre-submit jobs. We will need to adjust the required checks on branch protection to remove "markdown-toc" and "autogen" jobs, and also add the "formatting" job.CONTRIBUTING.md
was updated to include some more information about coding style and conventions.Testing Process
make format
Checklist