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

ci: Add formatting pre-submit check #3654

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

ianlewis
Copy link
Member

@ianlewis ianlewis commented May 15, 2024

Summary

Adds a formatting pre-submit check that runs make format and checks for file differences. The results of running make 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 the third_party directory for convenience sake.

markdown-toc and autogen are now run by make 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

  1. Run make format
  2. Verify the formatting results

Checklist

  • Review the contributing guidelines
  • Add a reference to related issues in the PR description.
  • Update documentation if applicable.
  • Add unit tests if applicable.
  • Add changes to the CHANGELOG if applicable.

Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
@ianlewis ianlewis marked this pull request as ready for review May 16, 2024 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant