Files
2026-07-13 13:17:40 +08:00

147 lines
3.6 KiB
Bash
Executable File

#!/bin/bash
#
# This script runs all the lint checks.
#
set -exuo pipefail
clang_format() {
pip install -c python/requirements_compiled.txt clang-format
./ci/lint/check-git-clang-format-output.sh
}
pre_commit() {
# Run pre-commit on all files
# TODO(MortalHappiness): Run all pre-commit checks because currently we only run some of them.
pip install -c python/requirements_compiled.txt pre-commit clang-format
HOOKS=(
python-no-log-warn
ruff
check-added-large-files
check-ast
check-toml
black
prettier
mypy
rst-directive-colons
rst-inline-touching-normal
python-check-mock-methods
clang-format
shellcheck
docstyle
check-import-order
check-cpp-files-inclusion
end-of-file-fixer
check-json
trailing-whitespace
cpplint
buildifier
buildifier-lint
eslint
)
for HOOK in "${HOOKS[@]}"; do
pre-commit run "$HOOK" --all-files --show-diff-on-failure
done
}
pre_commit_pydoclint() {
# Run pre-commit pydoclint on all files
pip install -c python/requirements_compiled.txt pre-commit clang-format
pre-commit run pydoclint --all-files --show-diff-on-failure
}
code_format() {
pip install -c python/requirements_compiled.txt -r python/requirements/lint-requirements.txt
FORMAT_SH_PRINT_DIFF=1 ./ci/lint/format.sh --all-scripts
}
semgrep_lint() {
pip install -c python/requirements_compiled.txt semgrep pre-commit
pre-commit run semgrep --all-files --show-diff-on-failure
}
banned_words() {
./ci/lint/check-banned-words.sh
}
# Use system python to avoid conflicts with uv python in forge image
doc_readme() {
/usr/bin/python -m pip install -c python/requirements_compiled.txt docutils
cd python && /usr/bin/python setup.py check --restructuredtext --strict --metadata
}
dashboard_format() {
./ci/lint/check-dashboard-format.sh
}
copyright_format() {
./ci/lint/copyright-format.sh -c
}
bazel_team() {
TMP_DIR="$(mktemp -d)"
bazelisk query 'kind("cc_test|py_test", //...)' --output=xml > "${TMP_DIR}/tests.xml"
bazelisk run //ci/lint:check_bazel_team_owner < "${TMP_DIR}/tests.xml"
rm -rf "${TMP_DIR}"
}
bazel_buildifier() {
./ci/lint/check-bazel-buildifier.sh
}
pytest_format() {
pip install -c python/requirements_compiled.txt yq
./ci/lint/check-pytest-format.sh
}
test_coverage() {
python ci/pipeline/check-test-run.py
}
_install_ray_no_deps() {
if [[ -d /opt/ray-build ]]; then
unzip -o -q /opt/ray-build/ray_pkg.zip -d python
unzip -o -q /opt/ray-build/ray_py_proto.zip -d python
mkdir -p python/ray/dashboard/client/build
tar -xzf /opt/ray-build/dashboard.tar.gz -C python/ray/dashboard/client/build
SKIP_BAZEL_BUILD=1 pip install -e "python[all]" --no-deps
else
RAY_DISABLE_EXTRA_CPP=1 pip install -e "python[all]" --no-deps
fi
}
api_annotations() {
echo "--- Install Ray"
_install_ray_no_deps
echo "--- Check API annotations"
./ci/lint/check_api_annotations.py
}
api_policy_check() {
# install ray and compile doc to generate API files
echo "--- Build doc pages"
make -C doc/ html
echo "--- Install Ray"
_install_ray_no_deps
echo "--- Check API/doc consistency"
# Run via the image interpreter, not `bazel run`: the bazel target's @py_deps_py310
# (cp310) wheels can't import under the py3.11 docbuild image (e.g. rpds).
# TODO(elliot-barn): #64070 switch back to bazel once hermetic python 3.11 is setup
PYTHONPATH="$(pwd)${PYTHONPATH:+:$PYTHONPATH}" python ci/ray_ci/doc/cmd_check_api_discrepancy.py /ray "$@"
}
documentation_style() {
./ci/lint/check-documentation-style.sh
}
doc_no_new_rst() {
python doc/test_no_new_rst.py
}
"$@"