Skip to content

Enable docs preview upload for nightly builds #3718

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.

Sign up for GitHub

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
svekars merged 3 commits into from
Jan 6, 2026
Merged

Enable docs preview upload for nightly builds #3718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa50e64
Enable docs preview upload for nightly builds
svekars Jan 5, 2026
791add5
Update
svekars Jan 5, 2026
090eb06
Use prefix instead
svekars Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/_build-tutorials-base.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ on:
required: false
type: number
default: 0
S3_PREFIX:
description: "S3 prefix path for uploading docs preview"
required: false
type: string
default: "pytorch/tutorials"

jobs:
worker:
Expand Down Expand Up @@ -187,7 +192,7 @@ jobs:
s3-bucket: doc-previews
if-no-files-found: error
path: docs
s3-prefix: pytorch/tutorials/${{ github.event.pull_request.number }}
s3-prefix: ${{ inputs.S3_PREFIX }}/${{ github.event.pull_request.number }}

- name: Teardown Linux
uses: pytorch/test-infra/.github/actions/teardown-linux@main
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/build-tutorials-nightly.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ jobs:
secrets: inherit
with:
USE_NIGHTLY: 1
UPLOAD: 0
UPLOAD: 1
S3_PREFIX: pytorch/tutorials-nightly-preview
14 changes: 11 additions & 3 deletions .jenkins/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ set -ex

export BUCKET_NAME=pytorch-tutorial-build-pull-request

# Set build prefix based on whether this is a nightly build or not
# This prevents conflicts when both builds run simultaneously
if [ "${USE_NIGHTLY:-0}" -eq 1 ]; then
export BUILD_PREFIX="nightly"
else
export BUILD_PREFIX="stable"
fi

# set locale for click dependency in spacy
export LC_ALL=C.UTF-8
export LANG=C.UTF-8
Expand Down Expand Up @@ -122,7 +130,7 @@ if [[ "${JOB_TYPE}" == "worker" ]]; then
# Step 6: Copy generated files to S3, tag with commit ID
if [ "${UPLOAD:-0}" -eq 1 ]; then
7z a worker_${WORKER_ID}.7z docs
awsv2 s3 cp worker_${WORKER_ID}.7z s3://${BUCKET_NAME}/${COMMIT_ID}/worker_${WORKER_ID}.7z
awsv2 s3 cp worker_${WORKER_ID}.7z s3://${BUCKET_NAME}/${BUILD_PREFIX}/${COMMIT_ID}/worker_${WORKER_ID}.7z
fi
elif [[ "${JOB_TYPE}" == "manager" ]]; then
# Step 1: Generate no-plot HTML pages for all tutorials
Expand All @@ -136,7 +144,7 @@ elif [[ "${JOB_TYPE}" == "manager" ]]; then
# Step 3: Download generated with-plot HTML files and static files from S3, merge into one folder
mkdir -p docs_with_plot/docs
for ((worker_id=1;worker_id<NUM_WORKERS+1;worker_id++)); do
awsv2 s3 cp s3://${BUCKET_NAME}/${COMMIT_ID}/worker_$worker_id.7z worker_$worker_id.7z
awsv2 s3 cp s3://${BUCKET_NAME}/${BUILD_PREFIX}/${COMMIT_ID}/worker_$worker_id.7z worker_$worker_id.7z
7z x worker_$worker_id.7z -oworker_$worker_id
yes | cp -R worker_$worker_id/docs/* docs_with_plot/docs
done
Expand All @@ -153,7 +161,7 @@ elif [[ "${JOB_TYPE}" == "manager" ]]; then

# Step 6: Copy generated HTML files and static files to S3
7z a manager.7z docs
awsv2 s3 cp manager.7z s3://${BUCKET_NAME}/${COMMIT_ID}/manager.7z
awsv2 s3 cp manager.7z s3://${BUCKET_NAME}/${BUILD_PREFIX}/${COMMIT_ID}/manager.7z

# Step 7: push new HTML files and static files to gh-pages
if [[ "$COMMIT_SOURCE" == "refs/heads/master" || "$COMMIT_SOURCE" == "refs/heads/main" ]]; then
Expand Down