mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 12:54:11 +08:00
a1ad28da10
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/61119 This change spilts the clang-tidy CI job into smaller steps and uses a refactored version of the clang_tidy.py script. The new folder structure is as follows: ``` tools/linter/clang_tidy |_ __main__py |_ requirements.txt |_ run.py |_ setup.sh ``` `__main__.py` This script will run `tools/linter/clang_tidy/setup.sh` if a `build` directory doesn't exist, mimicing what used to be done as a separate step in the CI job. After that, it will invoke `clang-tidy` with default arguments being declared in the script itself (as opposed to declaring them in lint.yml). The reasoning behind this approach is two-fold: - Make it easier to run `clang-tidy` locally using this script - De-duplicate the option passing `requirements.txt` Contains a list of additional python dependencies needed by the `clang-tidy` script. `setup.sh` If a build directory doesn't exist, this command will run the necessary codegen and build commands for running `clang-tidy` Example usage: ``` python3 tools/linter/clang_tidy --parallel ``` Notice that we don't have to put the `.py` at the end of `clang_tidy`. Test Plan: Run the following command: ``` python3 tools/linter/clang_tidy --paths torch/csrc/fx --parallel ``` Reviewed By: walterddr, janeyx99 Differential Revision: D29568582 Pulled By: 1ntEgr8 fbshipit-source-id: cd6d11c5cb8ba9f1344a87c35647a1cd8dd45b04
121 lines
3.8 KiB
Makefile
121 lines
3.8 KiB
Makefile
# This makefile does nothing but delegating the actual building to cmake.
|
|
PYTHON = python3
|
|
|
|
all:
|
|
@mkdir -p build && cd build && cmake .. $(shell $(PYTHON) ./scripts/get_python_cmake_flags.py) && $(MAKE)
|
|
|
|
local:
|
|
@./scripts/build_local.sh
|
|
|
|
android:
|
|
@./scripts/build_android.sh
|
|
|
|
ios:
|
|
@./scripts/build_ios.sh
|
|
|
|
clean: # This will remove ALL build folders.
|
|
@rm -r build*/
|
|
@$(RM) -r $(SHELLCHECK_GHA_GENERATED_FOLDER)
|
|
|
|
linecount:
|
|
@cloc --read-lang-def=caffe.cloc caffe2 || \
|
|
echo "Cloc is not available on the machine. You can install cloc with " && \
|
|
echo " sudo apt-get install cloc"
|
|
|
|
SHELLCHECK_GHA_GENERATED_FOLDER=.shellcheck_generated_gha
|
|
shellcheck-gha:
|
|
@$(RM) -r $(SHELLCHECK_GHA_GENERATED_FOLDER)
|
|
tools/extract_scripts.py --out=$(SHELLCHECK_GHA_GENERATED_FOLDER)
|
|
tools/linter/run_shellcheck.sh $(SHELLCHECK_GHA_GENERATED_FOLDER)
|
|
|
|
generate-gha-workflows:
|
|
.github/scripts/generate_ci_workflows.py
|
|
$(MAKE) shellcheck-gha
|
|
|
|
shellcheck:
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
--file .github/workflows/lint.yml \
|
|
--job 'shellcheck' \
|
|
--step "Regenerate workflows"
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
--file .github/workflows/lint.yml \
|
|
--job 'shellcheck' \
|
|
--step "Assert that regenerating the workflows didn't change them"
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
--file .github/workflows/lint.yml \
|
|
--job 'shellcheck' \
|
|
--step 'Extract scripts from GitHub Actions workflows'
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
$(CHANGED_ONLY) \
|
|
--job 'shellcheck'
|
|
|
|
setup_lint:
|
|
$(PYTHON) tools/actions_local_runner.py --file .github/workflows/lint.yml \
|
|
--job 'flake8-py3' --step 'Install dependencies' --no-quiet
|
|
$(PYTHON) tools/actions_local_runner.py --file .github/workflows/lint.yml \
|
|
--job 'cmakelint' --step 'Install dependencies' --no-quiet
|
|
$(PYTHON) tools/actions_local_runner.py --file .github/workflows/lint.yml \
|
|
--job 'mypy' --step 'Install dependencies' --no-quiet
|
|
$(PYTHON) tools/actions_local_runner.py --file .github/workflows/lint.yml \
|
|
--job 'shellcheck' --step 'Install Jinja2' --no-quiet
|
|
|
|
@if [ "$$(uname)" = "Darwin" ]; then \
|
|
if [ -z "$$(which brew)" ]; then \
|
|
echo "'brew' is required to install ShellCheck, get it here: https://brew.sh "; \
|
|
exit 1; \
|
|
fi; \
|
|
brew install shellcheck; \
|
|
else \
|
|
$(PYTHON) tools/actions_local_runner.py --file .github/workflows/lint.yml \
|
|
--job 'shellcheck' --step 'Install ShellCheck' --no-quiet; \
|
|
fi
|
|
pip install jinja2
|
|
pip install -r tools/linter/clang_tidy/requirements.txt
|
|
|
|
quick_checks:
|
|
# TODO: This is broken when 'git config submodule.recurse' is 'true' since the
|
|
# lints will descend into third_party submodules
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
--file .github/workflows/lint.yml \
|
|
--job 'quick-checks' \
|
|
--step 'Ensure no trailing spaces' \
|
|
--step 'Ensure no tabs' \
|
|
--step 'Ensure no non-breaking spaces' \
|
|
--step 'Ensure canonical include' \
|
|
--step 'Ensure no versionless Python shebangs' \
|
|
--step 'Ensure no unqualified noqa' \
|
|
--step 'Ensure no unqualified type ignore' \
|
|
--step 'Ensure no direct cub include' \
|
|
--step 'Ensure correct trailing newlines'
|
|
|
|
flake8:
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
$(CHANGED_ONLY) \
|
|
--job 'flake8-py3'
|
|
|
|
mypy:
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
$(CHANGED_ONLY) \
|
|
--job 'mypy'
|
|
|
|
cmakelint:
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
--file .github/workflows/lint.yml \
|
|
--job 'cmakelint' \
|
|
--step 'Run cmakelint'
|
|
|
|
clang_tidy:
|
|
echo "clang-tidy local lint is not yet implemented"
|
|
exit 1
|
|
|
|
toc:
|
|
@$(PYTHON) tools/actions_local_runner.py \
|
|
--file .github/workflows/lint.yml \
|
|
--job 'toc' \
|
|
--step "Regenerate ToCs and check that they didn't change"
|
|
|
|
lint: flake8 mypy quick_checks cmakelint shellcheck
|
|
|
|
quicklint: CHANGED_ONLY=--changed-only
|
|
quicklint: mypy flake8 quick_checks cmakelint shellcheck
|