Skip to content
This repository was archived by the owner on May 20, 2026. It is now read-only.

Commit 9d83cb5

Browse files
authored
ci: Add workflow to publish docs (#90)
* Add workflow to publish docs Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Update release-docs request name Signed-off-by: Charlie Truong <chtruong@nvidia.com> * Remove unused variable in publish docs job Signed-off-by: Charlie Truong <chtruong@nvidia.com> --------- Signed-off-by: Charlie Truong <chtruong@nvidia.com>
1 parent 67f2867 commit 9d83cb5

1 file changed

Lines changed: 65 additions & 0 deletions

File tree

.github/workflows/release-docs.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Copyright (c) 2026, NVIDIA CORPORATION.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
name: Release docs
15+
on:
16+
workflow_dispatch:
17+
inputs:
18+
dry-run:
19+
description: Whether to run the workflow in dry-run mode
20+
required: true
21+
type: boolean
22+
default: true
23+
notify-emails:
24+
description: Email addresses to send the notification to. Format as "me@me.com,you@you.com".
25+
required: true
26+
type: string
27+
28+
jobs:
29+
build-docs:
30+
uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.67.0
31+
32+
publish-docs:
33+
runs-on: ubuntu-latest
34+
needs: [build-docs]
35+
steps:
36+
- uses: actions/checkout@v6
37+
with:
38+
repository: NVIDIA-NeMo/FW-CI-templates
39+
ref: v0.67.2
40+
path: FW-CI-templates
41+
42+
- uses: ./FW-CI-templates/.github/actions/publish-docs
43+
# This workflow runs either on main, or on a version tag. Any other git ref will lead
44+
# to an error.
45+
# If its on main, it will publish to "latest" directory in Akamai.
46+
# If its on a versioned tag, it will extract the version number from the tag (strip `v` prefix)
47+
# and publish to the versioned directory in Akamai.
48+
with:
49+
dry-run: ${{ inputs.dry-run }}
50+
artifacts-name: docs-html
51+
artifacts-path: _build/html
52+
emails-csv: ${{ inputs.notify-emails && format('{0},{1}', vars.docs_release_emails, inputs.notify-emails) || vars.docs_release_emails }}
53+
overwrite-latest-on-tag: false
54+
run-on-version-tag-only: ${{ github.ref_name != 'main' }}
55+
request-name: dfm-publish-docs-${{ github.run_id }}
56+
aws-region: ${{ var.DOCS_AWS_REGION }}
57+
aws-role-to-assume: ${{ secrets.AWS_ASSUME_ROLE_ARN }}
58+
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
59+
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
60+
akamai-host: ${{ secrets.AKAMAI_HOST }}
61+
akamai-client-token: ${{ secrets.AKAMAI_CLIENT_TOKEN }}
62+
akamai-client-secret: ${{ secrets.AKAMAI_CLIENT_SECRET }}
63+
akamai-access-token: ${{ secrets.AKAMAI_ACCESS_TOKEN }}
64+
s3-target-root: ${{ secrets.S3_BUCKET_NAME }}
65+
s3-target-path: nemo/dfm

0 commit comments

Comments
 (0)