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

DAOS-16923 cq: make clang-format required #15685

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

daltonbohning
Copy link
Contributor

Make clang-format GHA required on PRs.

Skip-build: true

Before requesting gatekeeper:

  • Two review approvals and any prior change requests have been resolved.
  • Testing is complete and all tests passed or there is a reason documented in the PR why it should be force landed and forced-landing tag is set.
  • Features: (or Test-tag*) commit pragma was used or there is a reason documented that there are no appropriate tags for this PR.
  • Commit messages follows the guidelines outlined here.
  • Any tests skipped by the ticket being addressed have been run and passed in the PR.

Gatekeeper:

  • You are the appropriate gatekeeper to be landing the patch.
  • The PR has 2 reviews by people familiar with the code, including appropriate owners.
  • Githooks were used. If not, request that user install them and check copyright dates.
  • Checkpatch issues are resolved. Pay particular attention to ones that will show up on future PRs.
  • All builds have passed. Check non-required builds for any new compiler warnings.
  • Sufficient testing is done. Check feature pragmas and test tags and that tests skipped for the ticket are run and now pass with the changes.
  • If applicable, the PR has addressed any potential version compatibility issues.
  • Check the target branch. If it is master branch, should the PR go to a feature branch? If it is a release branch, does it have merge approval in the JIRA ticket.
  • Extra checks if forced landing is requested
    • Review comments are sufficiently resolved, particularly by prior reviewers that requested changes.
    • No new NLT or valgrind warnings. Check the classic view.
    • Quick-build or Quick-functional is not used.
  • Fix the commit message upon landing. Check the standard here. Edit it to create a single commit. If necessary, ask submitter for a new summary.

Make clang-format GHA required on PRs.

Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning daltonbohning self-assigned this Jan 6, 2025
@daltonbohning daltonbohning marked this pull request as ready for review January 6, 2025 17:51
@daltonbohning daltonbohning requested a review from a team as a code owner January 6, 2025 17:51
Copy link

github-actions bot commented Jan 6, 2025

Ticket title is 'Make clang-format required on PRs'
Status is 'In Progress'
https://daosio.atlassian.net/browse/DAOS-16923

@daltonbohning
Copy link
Contributor Author

@mchaarawi Per request, it's this simple to make clang-format required. Should we alert devs before merging this?

@daltonbohning
Copy link
Contributor Author

Note that since this is version controlled, inflight PRs will not be affected until this change is merged into their branch

Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
@daltonbohning daltonbohning requested a review from a team as a code owner January 6, 2025 19:04
Since it may conflict with system.

Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
Skip-build: true

Signed-off-by: Dalton Bohning <[email protected]>
@jolivier23
Copy link
Contributor

I think you're going to get some pushback internally on this one. I'm personally ok with it.

@jolivier23
Copy link
Contributor

If it's required, does it mean a PR has to be force landed. You might want to add or point to documentation for the comments to disable it (such as for FOREACH macros) when it does weird things.

@daltonbohning
Copy link
Contributor Author

If it's required, does it mean a PR has to be force landed. You might want to add or point to documentation for the comments to disable it (such as for FOREACH macros) when it does weird things.

If it's required, does it mean a PR has to be force landed

Right. It either needs to pass or needs force landing.

documentation for the comments to disable it (such as for FOREACH macros) when it does weird things

I don't work with C code enough to know - do you have an example of this? Or do you mean disable the hook with DAOS_GITHOOK_SKIP? (which would then require force landing)

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

Successfully merging this pull request may close these issues.

2 participants