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

*: add pre-commit #43343

Merged
merged 4 commits into from
Apr 24, 2023
Merged

*: add pre-commit #43343

merged 4 commits into from
Apr 24, 2023

Conversation

hawkingrei
Copy link
Member

@hawkingrei hawkingrei commented Apr 24, 2023

What problem does this PR solve?

Issue Number: ref #43346

Problem Summary:

What is changed and how it works?

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
brew install pre-commit
pre-commit install

# give some commit and you will see the checking by pre-commit.
  • No code

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

Signed-off-by: Weizhen Wang <wangweizhen@pingcap.com>
@ti-chi-bot
Copy link

ti-chi-bot bot commented Apr 24, 2023

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • tiancaiamao
  • xhebox

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot bot added do-not-merge/needs-linked-issue release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 24, 2023
Signed-off-by: Weizhen Wang <wangweizhen@pingcap.com>
Signed-off-by: Weizhen Wang <wangweizhen@pingcap.com>
@ti-chi-bot ti-chi-bot bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 24, 2023
Signed-off-by: Weizhen Wang <wangweizhen@pingcap.com>
@hawkingrei hawkingrei added the skip-issue-check Indicates that a PR no need to check linked issue. label Apr 24, 2023
@hawkingrei hawkingrei removed the skip-issue-check Indicates that a PR no need to check linked issue. label Apr 24, 2023
Copy link
Contributor

@xhebox xhebox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to tell everyone that they need to install bazel now.

@ti-chi-bot ti-chi-bot bot added the status/LGT1 Indicates that a PR has LGTM 1. label Apr 24, 2023
@hawkingrei
Copy link
Member Author

I think you need to tell everyone that they need to install bazel now.

We can add a guide to check the environment and tell developers what to install while they are running the pre-commit.

BTW, pr-commit is not mandatory.

@ti-chi-bot ti-chi-bot bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Apr 24, 2023
@tiancaiamao
Copy link
Contributor

cat .git/hooks/pre-commit.sample

Should the .git/hooks directory be added to git? I'm not sure what is the best practice.

@hawkingrei
Copy link
Member Author

hawkingrei commented Apr 24, 2023

cat .git/hooks/pre-commit.sample

Should the .git/hooks directory be added to git? I'm not sure what is the best practice.

I don't want to force every developer to use pre-commit. It is optional. If you want to use it, you can pre-commit install. If you want to remove, you only pre-commit uninstall. It is free for developers.

@hawkingrei hawkingrei requested review from lance6716 and qw4990 April 24, 2023 07:08
@hawkingrei hawkingrei requested a review from tisonkun April 24, 2023 10:42
@hawkingrei
Copy link
Member Author

/merge

@ti-chi-bot
Copy link

ti-chi-bot bot commented Apr 24, 2023

This pull request has been accepted and is ready to merge.

Commit hash: 245fdf2

@ti-chi-bot ti-chi-bot bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 24, 2023
@tisonkun
Copy link
Contributor

We can add a guide to check the environment and tell developers what to install while they are running the pre-commit.

@hawkingrei You can send a PR against https://github.com/pingcap/tidb-dev-guide and share the written page among the community. May or may not just file an issue right now :)

@hawkingrei
Copy link
Member Author

We can add a guide to check the environment and tell developers what to install while they are running the pre-commit.

@hawkingrei You can send a PR against https://github.com/pingcap/tidb-dev-guide and share the written page among the community. May or may not just file an issue right now :)

OK, I will do it and this PR will not close this issue.

@hawkingrei hawkingrei merged commit a5ef282 into pingcap:master Apr 24, 2023
@hawkingrei hawkingrei deleted the support_precommit branch April 24, 2023 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants