Skip to content

Commit b20b3b0

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 b20b3b0

1 file changed

Lines changed: 23 additions & 15 deletions

File tree

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

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,29 @@ 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: false
13+
default: 'master'
14+
eos_upload_directory:
15+
description: 'Make documentation available at <root-website>/doc/<directory>. Leave empty for skipping the upload to eos.'
16+
type: string
17+
required: false
18+
default: 'master'
1219

1320
workflow_dispatch:
1421
inputs:
15-
incremental:
16-
description: 'Do full build'
17-
type: boolean
22+
input_branch:
23+
description: 'Which branch to build documentation for'
24+
type: string
25+
required: false
26+
default: 'master'
27+
eos_upload_directory:
28+
description: 'Make documentation available at <root-website>/doc/<directory>. Leave empty for skipping the upload to eos.'
29+
type: string
1830
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
31+
default: 'master'
2532

2633
jobs:
2734
build-docs:
@@ -36,8 +43,8 @@ jobs:
3643
PLATFORM: alma10
3744
DOC_DIR: master
3845
DOC_LOCATION: /github/home
39-
BASE_REF: master
40-
WEB_DIR_NAME: master
46+
BASE_REF: ${{ inputs.input_branch == null && 'master' || inputs.input_branch }}
47+
WEB_DIR_NAME: ${{ inputs.eos_upload_directory == null && '' || inputs.eos_upload_directory }}
4148
TAR_FILE: htmlmaster.tar.gz
4249

4350
permissions:
@@ -75,7 +82,7 @@ jobs:
7582
run: ".github/workflows/root-ci-config/build_root.py
7683
--buildtype Release
7784
--platform ${{ env.PLATFORM }}
78-
--incremental ${{ inputs.incremental }}
85+
--incremental false
7986
--base_ref ${BASE_REF}
8087
--head_ref ${BASE_REF}
8188
--binaries false
@@ -111,6 +118,7 @@ jobs:
111118
if-no-files-found: error
112119

113120
- name: Sync documentation to EOS
121+
if: ${{ env.WEB_DIR_NAME != null && env.WEB_DIR_NAME != '' }}
114122
env:
115123
RWEBEOS_KT: ${{ secrets.RWEBEOS_KT }}
116124
KRB5USER: ${{ secrets.KRB5USER }}

0 commit comments

Comments
 (0)