Visitar URL original
starrocks/build-support at main · APIJSON/starrocks · GitHub
Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

build-support

Brief notes on helper scripts in this directory.

  • build-support/check-format.sh: Check clang-format across be/src and be/test without modifying files. Usage: bash build-support/check-format.sh
  • build-support/check_be_module_boundaries.py: Enforce the BE module-boundary manifest in be/module_boundary_manifest.json, including include edges, explicit target links, focused core-test link deps, and shrink-only ExecEnv guardrails. Uses build-support/be_module_boundary_baseline.json for reviewed legacy debt, build-support/exec_env_header_include_allowlist.txt for direct header includes of exec/exec_env.h, build-support/exec_env_singleton_allowlist.txt for production ExecEnv::GetInstance() call sites, and --enforce-baseline-shrink to ensure that baseline can only shrink over time. Usage: python3 build-support/check_be_module_boundaries.py --mode full, python3 build-support/check_be_module_boundaries.py --mode changed --base origin/main, or python3 build-support/check_be_module_boundaries.py --mode changed --base origin/main --enforce-baseline-shrink
  • build-support/check_gensrc_schema_compatibility.py: Enforce thrift and protobuf compatibility rules for gensrc/thrift/*.thrift and gensrc/proto/*.proto, including optional-compatible additions, renumber detection, type/cardinality stability, deletion waivers, and stale-waiver cleanup. Usage: python3 build-support/check_gensrc_schema_compatibility.py --mode changed --base origin/main or python3 build-support/check_gensrc_schema_compatibility.py --mode full --base origin/main
  • build-support/check_repo_handbook.py: Validate the internal handbook/ knowledge tree, including required entrypoints, domain/policy/quality indexes, page heading contracts, active-plan metadata, and AGENTS/CLAUDE navigation links. Usage: python3 build-support/check_repo_handbook.py
  • build-support/check_common_config_header_includes.sh: Guardrail check that generated config_<domain>_fwd.h headers are up to date and only allowlisted C++ files in be/src or be/test directly include common/config.h. Usage: bash build-support/check_common_config_header_includes.sh (also the manual command for branch/backport validation).
  • build-support/handbook_plan.py: Create, list, and complete gitignored local handbook plans under handbook/plans/local/, including checkout-local overrides of tracked plans and directory-root local trees at handbook/plans/local/active/<slug>/README.md. Usage: python3 build-support/handbook_plan.py list, python3 build-support/handbook_plan.py create --local --title "Scratch Plan" --owner "Engineering Productivity", python3 build-support/handbook_plan.py create --local --from handbook/plans/active/<plan>.md, or python3 build-support/handbook_plan.py complete --local --plan <path-or-slug>
  • build-support/clang-format-changed-check.sh: Check clang-format only on C++ files changed since origin/main (falls back to full check if missing). Usage: bash build-support/clang-format-changed-check.sh
  • build-support/clang-format-changed.sh: Apply clang-format to C++ files changed since origin/main (falls back to full format if missing). Usage: bash build-support/clang-format-changed.sh
  • build-support/clang-format.sh: Apply clang-format across be/src and be/test. Usage: bash build-support/clang-format.sh
  • build-support/clang-tidy.sh: Unified clang-tidy entry for CI and local runs.
    • Full mode: ./build-support/clang-tidy.sh --mode full --branch main --build-type Release -j 32 --add-compile-options "--use-staros"
    • Changed mode: ./build-support/clang-tidy.sh --mode changed --base-version <base_sha> --branch main --build-type Release -j 32 --add-compile-options "--use-staros"
    • Legacy-compatible forms:
      • ./build-support/clang-tidy.sh run-full <branch> <build_type> <j_parallel> [add_compile_options]
      • ./build-support/clang-tidy.sh run-changed <base_version> <branch> <build_type> <j_parallel> [add_compile_options]
  • build-support/compile_time.sh: Collect and report compile-time statistics (clang). Usage: bash build-support/compile_time.sh
  • build-support/darwin_build_env.sh: Internal macOS ARM64 environment setup sourced by the root build helpers. Use ./build.sh --be rather than sourcing it directly.
  • build-support/format_changed_files.py: Filter a list of changed files to C++ sources within target dirs. Usage: python3 build-support/format_changed_files.py --help
  • build-support/gen_config_fwd_headers.py: Generate or validate committed be/src/common/config_<domain>_fwd.h headers from be/src/common/config.h. The selection manifest lives at be/src/common/config_fwd_headers_manifest.json. The generator preserves selected configs' surrounding preprocessor guards and, by default, only rewrites files whose content changed so unchanged headers keep their timestamps. Usage: python3 build-support/gen_config_fwd_headers.py, python3 build-support/gen_config_fwd_headers.py --check, or python3 build-support/gen_config_fwd_headers.py --force
  • build-support/gen_build_version.py: Generate build version metadata. Usage: python3 build-support/gen_build_version.py --help
  • build-support/gen_notice.py: Generate NOTICE file content from bundled licenses. Usage: python3 build-support/gen_notice.py --help
  • build-support/lintutils.py: Shared helpers for lint/format scripts. Imported by other scripts.
  • build-support/render_be_agents.py: Render or verify the generated module-boundary section inside be/AGENTS.md from be/module_boundary_manifest.json. Usage: python3 build-support/render_be_agents.py --write or python3 build-support/render_be_agents.py --check
  • build-support/run_clang_format.py: Run clang-format in check or fix mode for given dirs. Usage: python3 build-support/run_clang_format.py --help
  • build-support/schema_compatibility_waivers.json: Reviewed compatibility exceptions for deliberate thrift or protobuf removals or other schema waivers. Keep entries narrow and delete them once no longer needed.
  • build-support/sync_pom_to_gradle.py: Sync Maven POM settings into Gradle config. Usage: python3 build-support/sync_pom_to_gradle.py --help