Skip to content

Document the CI environment variables and their defaults - #431

Open
Hoiyeuhng wants to merge 1 commit into
vllm-project:mainfrom
Hoiyeuhng:docs/clarify-ci-readme
Open

Document the CI environment variables and their defaults#431
Hoiyeuhng wants to merge 1 commit into
vllm-project:mainfrom
Hoiyeuhng:docs/clarify-ci-readme

Conversation

@Hoiyeuhng

@Hoiyeuhng Hoiyeuhng commented Jul 22, 2026

Copy link
Copy Markdown

Summary

  • give the environment variable table a Default column and state each variable's actual default
  • correct the rows that stated the wrong default or omitted it
  • document TORCH_NIGHTLY, CONTINUE_ON_FAILURE and VLLM_CI_ONLY_STEP_KEYS
  • add .github/ and scripts/, the two top-level directories missing from the repository tree

Documentation only. git diff and git diff -w report identical line counts, so there is no whitespace-only churn here.

Why

The table folds defaults into prose for two rows and omits them for the rest, so there is no way to tell whether an unset variable means 0, 1, or "the bootstrap decides". Two rows were also inaccurate: RUN_ALL is set by more than an explicit override, and VLLM_USE_PRECOMPILED is chosen by the bootstrap from wheel availability rather than being a plain 1/0 switch.

Validation

Every row was checked against the code that reads it: the defaults block and label checks in buildkite/bootstrap-intel.sh; PRIORITY, NOAUTO, SKIP_TIMEOUT and CONTINUE_ON_FAILURE in buildkite_step.py; VLLM_CI_ONLY_STEP_KEYS in global_config.py; and the precompiled-wheel selection in bootstrap-intel.sh plus docker/ci.hcl.

bootstrap-intel.sh also assigns a default to VLLM_CI_REPO, but nothing in this repository reads it, so I left it undocumented rather than guessing at its contract.

pre-commit run --files README.md passes and git diff --check is clean.

Related

The AMD template input reference fix previously bundled here is now #496.

AI assistance

AI assistance was used to research and prepare this change. The submitter has reviewed every changed line.

@Hoiyeuhng
Hoiyeuhng force-pushed the docs/clarify-ci-readme branch from 449eae2 to 73bda60 Compare July 22, 2026 19:57
@Hoiyeuhng
Hoiyeuhng force-pushed the docs/clarify-ci-readme branch 3 times, most recently from 7e8503f to 9dced72 Compare August 29, 2026 04:36
Give the environment variable table a Default column, correct the
entries that stated no default or the wrong one, and add TORCH_NIGHTLY,
CONTINUE_ON_FAILURE and VLLM_CI_ONLY_STEP_KEYS. Also add the two
top-level directories missing from the repository tree.

Signed-off-by: Haiyang Luo <41023868+Hoiyeuhng@users.noreply.github.com>
@Hoiyeuhng
Hoiyeuhng force-pushed the docs/clarify-ci-readme branch from 9dced72 to 74efaa5 Compare August 29, 2026 04:54
@Hoiyeuhng Hoiyeuhng changed the title docs: clarify CI layout and configuration defaults Document the CI environment variables and their defaults Aug 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant