History

wangyin888 d19c2839b0 Update development tools and CI configuration - Upgrade clang-format to version 18.1.8 - Upgrade pylint to version 3.3.7 - Upgrade cpplint to version 2.0.2 - Update .jenkins directory path - Remove markdownlint_check tool - Update pylint rule set - Update clang-format regex patterns		2025-10-24 14:19:46 +08:00
..
githooks	Update development tools and CI configuration	2025-10-24 14:19:46 +08:00
README.md	Update development tools and CI configuration	2025-10-24 14:19:46 +08:00
README_CN.md	Update development tools and CI configuration	2025-10-24 14:19:46 +08:00
install_generic_tools.sh	Update development tools and CI configuration	2025-10-24 14:19:46 +08:00
install_system_specific_tools.sh	Update development tools and CI configuration	2025-10-24 14:19:46 +08:00

README.md

pre-push Quick Guide

Pre-push Quick Guide

Procedure for Using pre-push Locally

Check the environment.

Ensure that the Git tool, Python, and pip have been installed in the local environment. (The python --version command output indicates that the version is 3.9, 3.10 or 3.11.)

Use scripts to install code check tools.

Run the following command in the mindspore/ directory to perform automatic installation:

cd scripts/pre_commit
bash install_generic_tools.sh
bash install_system_specific_tools.sh

The cmakelint, codespell, cpplint, lizard, pylint and clang-formattools are installed using install_generic_tools.sh. The shellcheck tools are installed using install_system_specific_tools.sh.

Note:

The sudo command is involved when you run the install_system_specific_tools.sh command in the Linux or macOS environment. Ensure that you have the sudo permission.
Due to different local environments, some tools may fail to be installed or the installed tool version is too early. In this case, you can reinstall the tools by referring to Appendix: Manually Installing Code Check Tools.
We have different suggestions on the tool versions installed in different environments. For details, see Appendix: Suggestions on Tool Versions. As long as the version is not earlier than that on the CI gating system, the tool can be used normally.

Using pre-push

(1) Pull the latest code of the master branch.

(2) Set the hooks path of Git to the directory where the pre-push file is located. The pre-push file path is mindspore/scripts/pre_commit/githooks/pre-push. Run the following command in mindspore/:
```
git config core.hooksPath scripts/pre_commit/githooks
```
Note: The core.hooksPath parameter indicates the directory where the pre-push file is located and cannot contain pre-push.

(3) Execute pre-push.

You do not need to execute pre-push manually. Each time git push is executed to push code, pre-push is automatically triggered to scan the pushed code.

(4) View the execution result.

After pre-push is executed, Total error number is xxx is displayed, indicating the total number of scanned alarms. If the number of alarms is 0, the code will be pushed to the repository. Otherwise, the code push will be rejected. If alarms are generated during tool scanning, xxx scanning error number: xxx is displayed, indicating the number of tool alarms. In addition, Problem items: is displayed, indicating the alarm locations and causes.

(5) Bypass pre-push.

If you do not want the pushed code to be scanned or the alarms are generated by others' code, you can run the git push --no-verify command to push code and bypass the pre-push check.

Appendix: FAQs

Q: Why is the local scanning result inconsistent with that in the CI gating system?

A: The scanning result varies according to the environment. The local environment may be inconsistent with the CI environment. Therefore, the local scanning result is for reference only. Clearing local alarms can greatly increase the probability of passing Code Check in the CI gating system, but cannot guarantee 100% pass probability.
Q: How can I prevent the same alarms from being displayed locally when the scanned alarms are displayed only locally?

A: The preceding situation occurs on the cpplint, pylint, and lizard tools. Trustlists of the three tools are provided in the .jenkins/check/config directory. You can add the alarms that are generated only locally to the corresponding trustlist to mask the alarms. Do not push the modified trustlists to the CI repository.
Q: Why some tools are not installed or the installed tools are of earlier versions when the tools are automatically installed?

A: (1) To ensure that the original environment is not affected, the scripts use common installation commands to install the recommended versions. Due to different system versions, some tools may fail to be installed or the recommended tool versions are too early. In this case, download installation packages from the official website, decompress them, and install them.

(2) The Git tool has a built-in tab tool and does not need to be installed. Therefore, the tab tool is not involved during the installation.

(3) The scanning result of the Windows shellcheck tool is of no reference value. The installation script does not contain the Windows shellcheck tool. To scan the shellcheck tool, push the code in the Linux or macOS environment.
Q: Can I use pre-push if not all tools are successfully installed?

A: You can download any of the tools to use pre-push. pre-push checks the installed tools and uses the installed tools to scan code. If a tool is not installed, the corresponding scan is skipped.

Appendix: Manually Installing Code Check Tools

Some tools cannot be installed using scripts. You need to manually install them.

Windows Environment

In the Windows environment, run commands in the git bash window.

clang-format

(1) Install clang-format.

pip install --upgrade --force-reinstall clang-format