Skip to content

Commit 2388a71

Browse files
committed
[ci][docs] Add job inputs for manually triggered workflows.
- Add two job inputs for the workflow trigger. These should allow for choosing a ROOT version to build docs for, and for choosing a directory where the generated page should be served. Omitting the page means no upload to eos. - Remove the input "incremental". Since the documentation jobs don't upload or download anything, it never had an effect.
1 parent 6f619e2 commit 2388a71

1 file changed

Lines changed: 22 additions & 15 deletions

File tree

.github/workflows/root-docs-ci.yml

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,28 @@ on:
66
# providing the relevant branch as "default" value here:
77
workflow_call:
88
inputs:
9-
incremental:
10-
type: boolean
11-
default: true
9+
input_branch:
10+
description: 'Which branch to build documentation for'
11+
type: string
12+
required: true
13+
eos_upload_directory:
14+
description: 'Make documentation available at <root-website>/doc/<directory>. Leave empty for skipping the upload to eos.'
15+
type: string
16+
required: false
17+
default: ''
1218

1319
workflow_dispatch:
1420
inputs:
15-
incremental:
16-
description: 'Do full build'
17-
type: boolean
21+
input_branch:
22+
description: 'Which branch to build documentation for'
23+
type: string
24+
required: false
25+
default: 'master'
26+
eos_upload_directory:
27+
description: 'Make documentation available at <root-website>/doc/<directory>. Leave empty for skipping the upload to eos.'
28+
type: string
1829
required: false
19-
default: false
20-
# docu_input: # opportunity: overwrite makeinput.sh with these args
21-
# description: Folders to build documentation for. All folders are built if empty.
22-
# type: string
23-
# default: ""
24-
# required: false
30+
default: 'master'
2531

2632
jobs:
2733
build-docs:
@@ -36,8 +42,8 @@ jobs:
3642
PLATFORM: alma10
3743
DOC_DIR: master
3844
DOC_LOCATION: /github/home
39-
BASE_REF: master
40-
WEB_DIR_NAME: master
45+
BASE_REF: ${{ inputs.input_branch == null && 'master' || inputs.input_branch }}
46+
WEB_DIR_NAME: ${{ inputs.eos_upload_directory == null && '' || inputs.eos_upload_directory }}
4147
TAR_FILE: htmlmaster.tar.gz
4248

4349
permissions:
@@ -75,7 +81,7 @@ jobs:
7581
run: ".github/workflows/root-ci-config/build_root.py
7682
--buildtype Release
7783
--platform ${{ env.PLATFORM }}
78-
--incremental ${{ inputs.incremental }}
84+
--incremental false
7985
--base_ref ${BASE_REF}
8086
--head_ref ${BASE_REF}
8187
--binaries false
@@ -111,6 +117,7 @@ jobs:
111117
if-no-files-found: error
112118

113119
- name: Sync documentation to EOS
120+
if: ${{ env.WEB_DIR_NAME != null && env.WEB_DIR_NAME != '' }}
114121
env:
115122
RWEBEOS_KT: ${{ secrets.RWEBEOS_KT }}
116123
KRB5USER: ${{ secrets.KRB5USER }}

0 commit comments

Comments
 (0)