Skip to content

[skip changelog] Add formatting check to "Check Protocol Buffers" workflow #1391

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

Merged
merged 1 commit into from
Aug 12, 2021
Merged

[skip changelog] Add formatting check to "Check Protocol Buffers" workflow #1391

merged 1 commit into from
Aug 12, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 11, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Infrastructure enhancement

  • What is the current behavior?

The CI system checks the protocol buffers will compile and that they don't have any linting violations but it doesn't check for formatting style violations.

  • What is the new behavior?

On every push and pull request that affects relevant files, the protocol buffer files are checked for compliance with the LLVM code style (default of the ClangFormat formatter tool).

No break

  • Other information:

Demo workflow run with intentionally introduced formatting violation:
https://github.com/per1234/arduino-cli/runs/3303251386?check_suite_focus=true#step:5:14
(it was trailing whitespace, so not a great diff)

The version of ClangFormat pre-installed in the ubuntu-latest GitHub Actions runner is used for the check:
https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-README.md#language-and-runtime

…kflow

On every push and pull request that affects relevant files, check the protocol buffer files for code formatting
inconsistency.
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Aug 11, 2021
@per1234 per1234 merged commit ab31c21 into arduino:master Aug 12, 2021
@per1234 per1234 deleted the check-protobuf-format branch August 12, 2021 08:04
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants