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

[Lint] Improve clang-tidy and clang-format scripts running in lint #19175

Closed
wants to merge 1 commit into from

Conversation

mwtian
Copy link
Member

@mwtian mwtian commented Oct 7, 2021

This partially rolls forward commit 5d9e3a0, except changes to
scripts/format.h

Why are these changes needed?

  • Add more readability checks to clang-tidy
  • Disable modernize-use-nodiscard which is too pedantic.
  • On a branch just forked off master, diff against the current commit instead of the previous commit if there is local change for both clang-tidy and clang-format.
  • Make status messages stand out more in clang-tidy and clang-format.

These changes do not affect scripts/format.sh. These scripts currently only run during the lint step of the CI.

Related issue number

Checks

  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

This partially rolls forward commit 5d9e3a0, except changes to
scripts/format.h
@mwtian
Copy link
Member Author

mwtian commented Oct 7, 2021

The rllib failure is unrelated. It is fixed by bbc64a7.

@mwtian mwtian added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Oct 7, 2021
@scv119
Copy link
Contributor

scv119 commented Oct 7, 2021

@mwtian Does it make sense to separate it into two PRs to make it easier to get in? I.e. one just changing linter rules another change the the ci/travis/check-git-clang-format-output.sh ?

@mwtian
Copy link
Member Author

mwtian commented Oct 7, 2021

Sure, broke out clang-tidy rule changes to #19210.

@mwtian mwtian added @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. and removed tests-ok The tagger certifies test failures are unrelated and assumes personal liability. labels Oct 7, 2021
@ericl ericl removed their assignment Oct 11, 2021
@bveeramani
Copy link
Member

‼️ ACTION REQUIRED ‼️

We've switched our code formatter from YAPF to Black (see #21311).

To prevent issues with merging your code, here's what you'll need to do:

  1. Install Black
pip install -I black==21.12b0
  1. Format changed files with Black
curl -o format-changed.sh https://gist.githubusercontent.com/bveeramani/42ef0e9e387b755a8a735b084af976f2/raw/7631276790765d555c423b8db2b679fd957b984a/format-changed.sh
chmod +x ./format-changed.sh
./format-changed.sh
rm format-changed.sh
  1. Commit your changes.
git add --all
git commit -m "Format Python code with Black"
  1. Merge master into your branch.
git pull upstream master
  1. Resolve merge conflicts (if necessary).

After running these steps, you'll have the updated format.sh.

@stale
Copy link

stale bot commented Mar 19, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

  • If you'd like to keep this open, just leave any comment, and the stale label will be removed.

@stale stale bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Mar 19, 2022
@stale
Copy link

stale bot commented Apr 2, 2022

Hi again! The issue will be closed because there has been no more activity in the 14 days since the last message.

Please feel free to reopen or open a new issue if you'd still like it to be addressed.

Again, you can always ask for help on our discussion forum or Ray's public slack channel.

Thanks again for opening the issue!

@stale stale bot closed this Apr 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. stale The issue is stale. It will be closed within 7 days unless there are further conversation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants