[None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick #8736) #8754

ZhanruiSunCh · 2025-10-29T06:56:08Z

…(#8736)

Summary by CodeRabbit

Chores
- Updated build configuration to include documentation files in distribution packages.

Description

Test Coverage

PR Checklist

Please review the following before submitting your PR:

PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.

GitHub Bot Help

/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...

Provide a user friendly way for developers to interact with a Jenkins server.

Run /bot [-h|--help] to print this help message.

See details below for each supported subcommand.

Details

run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]

Launch build/test pipelines. All previously running jobs will be killed.

--reuse-test (optional)pipeline-id (OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.

--disable-reuse-test (OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.

--disable-fail-fast (OPTIONAL) : Disable fail fast on build/tests/infra failures.

--skip-test (OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.

--stage-list "A10-PyTorch-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.

--gpu-type "A30, H100_PCIe" (OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.

--test-backend "pytorch, cpp" (OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.

--only-multi-gpu-test (OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.

--disable-multi-gpu-test (OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.

--add-multi-gpu-test (OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.

--post-merge (OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.

--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" (OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".

--detailed-log (OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.

--debug (OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in the stage-list parameter to access the appropriate container environment. Note: Does NOT update GitHub check status.

For guidance on mapping tests to stage names, see docs/source/reference/ci-overview.md
and the scripts/test_to_stage_mapping.py helper.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip testing for latest commit on pull request. --comment "Reason for skipping build/test" is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

reuse-pipeline

reuse-pipeline

Reuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

…VIDIA#8736) Signed-off-by: Faraz Khoubsirat <58580514+farazkh80@users.noreply.github.com>

ZhanruiSunCh · 2025-10-29T06:56:28Z

/bot skip --comment "Cherry-pick"

coderabbitai · 2025-10-29T07:01:52Z

📝 Walkthrough

Walkthrough

The docker/Dockerfile.multi file was updated to include README.md in the file set for COPY commands across two locations. The destination for each COPY operation was extended from "./" to "./ README.md" without modifying other build stages or behavior.

Changes

Cohort / File(s)	Change Summary
Docker build configuration `docker/Dockerfile.multi`	Extended COPY commands in two locations to include README.md alongside existing files

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Simple, repetitive change: Adding the same file (README.md) to two identical COPY instructions
No logic complexity: Purely declarative Dockerfile modification
Clear intent: Self-evident what files are being included in the container image

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The PR description is largely incomplete despite following the repository template structure. While the template sections are present, the critical content areas—Description and Test Coverage—are entirely empty, containing only placeholder HTML comments with no explanatory text or test information. The PR Checklist shows one box checked, but this does not substitute for the missing substantive information about what changes were made, why they were necessary, or what tests safeguard these modifications. This falls short of the expected completeness for enabling reviewers to understand the change rationale and confidence in the implementation.	The author should fill out the Description section with an explanation of the issue being fixed (setup.py failure) and why adding README.md to the wheel stage COPY commands resolves it. The Test Coverage section should clearly identify the existing or new tests that validate this fix. While this is a cherry-pick of a previous PR, providing specific context in this PR's description will help reviewers understand the change in isolation.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "[None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick #8736)" directly corresponds to the actual changes made in the pull request. According to the raw summary, the modifications involve adding README.md to COPY commands in docker/Dockerfile.multi in two locations to prevent setup.py failures. The title is specific, follows the required repository format with a valid ticket prefix ([None]) and type ([fix]), and accurately describes the primary change without vague terminology. The reference to cherry-pick #8736 provides useful context for reviewers.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f49f42d and 94402d6.

📒 Files selected for processing (1)

docker/Dockerfile.multi (1 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: dbari
PR: NVIDIA/TensorRT-LLM#7095
File: docker/Dockerfile.multi:168-168
Timestamp: 2025-08-20T15:04:42.885Z
Learning: In docker/Dockerfile.multi, wildcard COPY for benchmarks (${CPP_BUILD_DIR}/benchmarks/*Benchmark) is intentionally used instead of directory copy because the benchmarks directory contains various other build artifacts during C++ builds, and only specific benchmark executables should be copied to the final image.

📚 Learning: 2025-08-20T15:04:42.885Z

Learnt from: dbari
PR: NVIDIA/TensorRT-LLM#7095
File: docker/Dockerfile.multi:168-168
Timestamp: 2025-08-20T15:04:42.885Z
Learning: In docker/Dockerfile.multi, wildcard COPY for benchmarks (${CPP_BUILD_DIR}/benchmarks/*Benchmark) is intentionally used instead of directory copy because the benchmarks directory contains various other build artifacts during C++ builds, and only specific benchmark executables should be copied to the final image.

Applied to files:

docker/Dockerfile.multi

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Pre-commit Check

🔇 Additional comments (1)

docker/Dockerfile.multi (1)

130-130: Add README.md to wheel stage COPY—fix is correct.

setup.py requires README.md at build time (line 221), and build_wheel.py invokes python -m build which reads setup.py during wheel construction. Without this file present in the Docker image, the wheel build fails. The change aligns with the existing pattern in the release stage and directly resolves the stated issue.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

tensorrt-cicd · 2025-10-29T07:01:54Z

PR_Github #22860 [ skip ] triggered by Bot. Commit: 94402d6

tensorrt-cicd · 2025-10-29T07:27:35Z

PR_Github #22860 [ skip ] completed with state SUCCESS. Commit: 94402d6
Skipping testing for commit 94402d6

[None][fix] add readme copy to wheel stage to avoid setup.py failure (N…

94402d6

…VIDIA#8736) Signed-off-by: Faraz Khoubsirat <58580514+farazkh80@users.noreply.github.com>

ZhanruiSunCh requested a review from a team as a code owner October 29, 2025 06:56

ZhanruiSunCh changed the title ~~[None][fix] add readme copy to wheel stage to avoid setup.py failure …~~ [None][fix] add readme copy to wheel stage to avoid setup.py failure (#8736) Oct 29, 2025

ZhanruiSunCh requested a review from chzblych October 29, 2025 06:57

ZhanruiSunCh changed the title ~~[None][fix] add readme copy to wheel stage to avoid setup.py failure (#8736)~~ [None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick !8736) Oct 29, 2025

ZhanruiSunCh changed the title ~~[None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick !8736)~~ [None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick #8736) Oct 29, 2025

chzblych approved these changes Oct 29, 2025

View reviewed changes

chzblych enabled auto-merge (squash) October 29, 2025 07:03

chzblych merged commit beafc39 into NVIDIA:release/1.1 Oct 29, 2025
13 of 15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick #8736) #8754

[None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick #8736) #8754

Uh oh!

ZhanruiSunCh commented Oct 29, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

ZhanruiSunCh commented Oct 29, 2025

Uh oh!

coderabbitai bot commented Oct 29, 2025

Walkthrough

Changes

Estimated code review effort

Uh oh!

tensorrt-cicd commented Oct 29, 2025

Uh oh!

tensorrt-cicd commented Oct 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick #8736) #8754

[None][fix] add readme copy to wheel stage to avoid setup.py failure (cherry-pick #8736) #8754

Uh oh!

Conversation

ZhanruiSunCh commented Oct 29, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Description

Test Coverage

PR Checklist

GitHub Bot Help

kill

skip

reuse-pipeline

Uh oh!

ZhanruiSunCh commented Oct 29, 2025

Uh oh!

coderabbitai bot commented Oct 29, 2025

Walkthrough

Changes

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

tensorrt-cicd commented Oct 29, 2025

Uh oh!

tensorrt-cicd commented Oct 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ZhanruiSunCh commented Oct 29, 2025 •

edited by coderabbitai bot

Loading