Skip to content

enh(doc): Add ci-overview in docs/source/reference/ #5137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 12, 2025

Conversation

venkywonka
Copy link
Collaborator

@venkywonka venkywonka commented Jun 11, 2025

  • Introduced a new “Continuous Integration Overview” reference page that adds basic documentation on CI, how to the tests in YAML files are run as stages in CI, and where to find their stage names in L0_Test.groovy.
  • Also documents how to trigger CI politely to preserve shared HW resources.
  • Includes a small link to the doc in the PR template.
  • This doc can be expanded further potentially to document more CI nuances that might help the developer.

Signed-off-by: Venky Ganesh <[email protected]>
@venkywonka venkywonka marked this pull request as ready for review June 11, 2025 23:16
@chzblych chzblych enabled auto-merge (squash) June 12, 2025 05:59
@chzblych
Copy link
Collaborator

/bot skip --stage-list "A10-Build_Docs"

Copy link

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.

run [--disable-fail-fast --skip-test --stage-list "A10-1, xxx" --gpu-type "A30, H100_PCIe" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-[Post-Merge]-1, xxx"]

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

--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-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-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.

--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. Will also run 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-[Post-Merge]-1, xxx" (OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-[Post-Merge]-1, xxx".

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.

@chzblych
Copy link
Collaborator

/bot run --stage-list "A10-Build_Docs"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #8610 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #8610 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #6249 (Partly Tested) completed with status: 'SUCCESS'

@chzblych
Copy link
Collaborator

/bot skip --comment "I reviewed the generated docs and LGTM"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #8658 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #8658 [ skip ] completed with state SUCCESS
Skipping testing for commit ec72c76

@chzblych chzblych merged commit 59c9588 into NVIDIA:main Jun 12, 2025
3 checks passed
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.

3 participants