Skip to content

Commit 1c3aa19

Browse files
committed
Dry-run of docs publishing
Signed-off-by: Charlie Truong <chtruong@nvidia.com>
1 parent 6822777 commit 1c3aa19

File tree

1 file changed

+69
-68
lines changed

1 file changed

+69
-68
lines changed

.github/workflows/release-docs.yml

Lines changed: 69 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -13,74 +13,75 @@
1313
# limitations under the License.
1414
name: Release docs
1515
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-
publish-as-latest:
24-
description: Publish as Latest stable version.
25-
required: false
26-
type: boolean
27-
default: true
28-
docs-version-override:
29-
description: Docs version if commit is not tagged
30-
required: false
31-
type: string
32-
default: ""
33-
update-version-picker:
34-
description: Update version picker.
35-
required: false
36-
type: boolean
37-
default: true
38-
notify-emails:
39-
description: Email addresses to send the notification to. Format as "me@me.com,you@you.com".
40-
required: false
41-
type: string
42-
github-ref:
43-
description: Github ref to checkout
44-
required: false
45-
type: string
46-
default: ""
47-
workflow_call:
48-
inputs:
49-
dry-run:
50-
description: Whether to run the workflow in dry-run mode
51-
required: false
52-
type: boolean
53-
default: true
54-
publish-as-latest:
55-
description: Publish as Latest stable version.
56-
required: false
57-
type: boolean
58-
default: true
59-
docs-version-override:
60-
description: Docs version if commit is not tagged
61-
required: false
62-
type: string
63-
default: ""
64-
update-version-picker:
65-
description: Update version picker.
66-
required: false
67-
type: boolean
68-
default: true
69-
notify-emails:
70-
description: Email addresses to send the notification to. Format as "me@me.com,you@you.com".
71-
required: false
72-
type: string
73-
github-ref:
74-
description: Github ref to checkout
75-
required: false
76-
type: string
77-
default: ""
16+
push:
17+
# workflow_dispatch:
18+
# inputs:
19+
# dry-run:
20+
# description: Whether to run the workflow in dry-run mode
21+
# required: true
22+
# type: boolean
23+
# default: true
24+
# publish-as-latest:
25+
# description: Publish as Latest stable version.
26+
# required: false
27+
# type: boolean
28+
# default: true
29+
# docs-version-override:
30+
# description: Docs version if commit is not tagged
31+
# required: false
32+
# type: string
33+
# default: ""
34+
# update-version-picker:
35+
# description: Update version picker.
36+
# required: false
37+
# type: boolean
38+
# default: true
39+
# notify-emails:
40+
# description: Email addresses to send the notification to. Format as "me@me.com,you@you.com".
41+
# required: false
42+
# type: string
43+
# github-ref:
44+
# description: Github ref to checkout
45+
# required: false
46+
# type: string
47+
# default: ""
48+
# workflow_call:
49+
# inputs:
50+
# dry-run:
51+
# description: Whether to run the workflow in dry-run mode
52+
# required: false
53+
# type: boolean
54+
# default: true
55+
# publish-as-latest:
56+
# description: Publish as Latest stable version.
57+
# required: false
58+
# type: boolean
59+
# default: true
60+
# docs-version-override:
61+
# description: Docs version if commit is not tagged
62+
# required: false
63+
# type: string
64+
# default: ""
65+
# update-version-picker:
66+
# description: Update version picker.
67+
# required: false
68+
# type: boolean
69+
# default: true
70+
# notify-emails:
71+
# description: Email addresses to send the notification to. Format as "me@me.com,you@you.com".
72+
# required: false
73+
# type: string
74+
# github-ref:
75+
# description: Github ref to checkout
76+
# required: false
77+
# type: string
78+
# default: ""
7879

7980
jobs:
8081
build-docs:
8182
uses: NVIDIA-NeMo/FW-CI-templates/.github/workflows/_build_docs.yml@v0.74.0
8283
with:
83-
ref: ${{ inputs.github-ref }}
84+
ref: chtruong/docs-publish
8485
docs-directory: docs/source
8586
sync-all: true
8687

@@ -101,14 +102,14 @@ jobs:
101102
# If its on a versioned tag, it will extract the version number from the tag (strip `v` prefix)
102103
# and publish to the versioned directory in Akamai.
103104
with:
104-
dry-run: ${{ inputs.dry-run }}
105+
dry-run: true
105106
artifacts-name: docs-html
106107
artifacts-path: _build/html
107108
emails-csv: ${{ inputs.notify-emails && format('{0},{1}', vars.docs_release_emails, inputs.notify-emails) || vars.docs_release_emails }}
108-
overwrite-latest-on-tag: ${{ inputs.publish-as-latest }}
109-
docs-version-override: ${{ inputs.docs-version-override }}
110-
update-version-picker: ${{ inputs.update-version-picker }}
111-
run-on-version-tag-only: ${{ github.ref_name != 'main' }}
109+
overwrite-latest-on-tag: false
110+
docs-version-override: nightly
111+
update-version-picker: true
112+
run-on-version-tag-only: false
112113
request-name: nemo-speech-publish-docs-${{ github.run_id }}
113114
aws-region: ${{ vars.DOCS_AWS_REGION }}
114115
aws-role-to-assume: ${{ secrets.AWS_ASSUME_ROLE_ARN }}

0 commit comments

Comments
 (0)