-
Notifications
You must be signed in to change notification settings - Fork 35
223 lines (199 loc) · 7.38 KB
/
build_pr_documentation.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
name: Build PR Documentation
env:
DIFFUSERS_SLOW_IMPORT: yes
on:
workflow_call:
inputs:
commit_sha:
required: true
type: string
pr_number:
required: true
type: string
package:
required: true
type: string
package_name:
type: string
description: "Should be used when a package name differs from its repostory name"
path_to_docs:
type: string
# supply --not_python_module for HF Course
additional_args:
type: string
languages:
# supply space-separated language codes
type: string
package_path:
type: string
install_rust:
type: boolean
install_libgl1:
type: boolean
# Command to execute before building the documentation
pre_command:
type: string
repo_owner:
type: string
default: 'huggingface'
description: "Owner of the repo to build documentation for. Defaults to 'huggingface'."
version_tag_suffix:
type: string
default: "src/"
description: "Suffix to add after the version tag (e.g. 1.3.0 or main) in the documentation links."
convert_notebooks:
type: boolean
description: "Convert notebooks to markdown files before building docs."
# Docker image to use for the build. Set custom_container="huggingface/transformers-doc-builder" if you need
# a complete install. Default to `""` which means CI will run on the runner directly.
custom_container:
type: string
default: ""
description: "Docker image to use for the build."
# Debug purposes only!
doc_builder_revision:
type: string
default: "main"
description: "Debug purposes only. Revision of `doc-builder` repo to use. Useful to test changes on `doc-builder`."
jobs:
build_pr_documentation:
runs-on: ubuntu-22.04
container:
${{ inputs.custom_container }}
env:
UV_HTTP_TIMEOUT: 900 # max 15min to install deps (shouldn't take more than 5min)
steps:
- uses: actions/checkout@v4
with:
repository: 'huggingface/doc-builder'
path: doc-builder
ref: ${{ inputs.doc_builder_revision }}
- uses: actions/checkout@v4
with:
repository: '${{ inputs.repo_owner }}/${{ inputs.package }}'
path: ${{ inputs.package }}
- uses: actions/setup-node@v4
with:
node-version: '20'
cache-dependency-path: "kit/package-lock.json"
- name: Export ROOT_APT_GET ('apt-get' or 'sudo apt-get')
# Use `sudo` only if running on the base runner.
# When using a container, `sudo` is not needed (and not installed)
run: |
if [ -z "${{ inputs.custom_container }}" ]
then
echo "ROOT_APT_GET=sudo apt-get" >> $GITHUB_ENV
else
echo "ROOT_APT_GET=apt-get" >> $GITHUB_ENV
fi
- name: Export PIP_OR_UV ('pip' or 'uv pip')
# Use `uv` only if running on the base runner.
# When using a container, `pip` has already been used to installed existing deps
# and is therefore quicker to resolve (already have some cached stuff).
run: |
if [ -z "${{ inputs.custom_container }}" ]
then
echo "PIP_OR_UV=uv pip" >> $GITHUB_ENV
else
echo "PIP_OR_UV=pip" >> $GITHUB_ENV
fi
- name: Set env variables
run: |
if [ -z "${{ inputs.path_to_docs }}" ]
then
echo "doc_folder=${{ inputs.package }}/docs/source" >> $GITHUB_ENV
echo "path_to_docs not provided, defaulting to ${{ inputs.package }}/docs/source"
else
echo "doc_folder=${{ inputs.path_to_docs }}" >> $GITHUB_ENV
fi
if [ -z "${{ inputs.package_name }}" ];
then
package_name=${{ inputs.package }}
else
package_name=${{ inputs.package_name }}
fi
if [ -z "${{ inputs.package_name }}" ];
then
echo "package_name=${{ inputs.package }}" >> $GITHUB_ENV
else
echo "package_name=${{ inputs.package_name }}" >> $GITHUB_ENV
fi
- name: Install libgl1
if: inputs.install_libgl1
run: $ROOT_APT_GET install -y libgl1
- name: Install Rust
uses: actions-rs/toolchain@v1
if: inputs.install_rust
with:
toolchain: stable
# Use venv in both cases
- name: Install uv
run: |
pip install -U uv
uv venv
- name: Setup environment
shell: bash
run: |
source .venv/bin/activate
$PIP_OR_UV uninstall doc-builder
cd doc-builder
git pull origin ${{ inputs.doc_builder_revision }}
$PIP_OR_UV install .
cd ..
if [[ -n "${{ inputs.package_path }}" ]]
then
cd ${{ inputs.package_path }}
$PIP_OR_UV install .[dev]
elif [[ "${{ inputs.additional_args }}" != *"--not_python_module"* ]];
then
cd ${{ inputs.package }}
$PIP_OR_UV install .[dev]
fi
cd ..
- name: Run pre-command
shell: bash
run: |
source .venv/bin/activate
if [ ! -z "${{ inputs.pre_command }}" ]
then
bash -c "${{ inputs.pre_command }}"
fi
- name: Convert notebooks to markdown files
if: inputs.convert_notebooks
run: |
source .venv/bin/activate
branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}
remaining_part=$(echo "${{ env.doc_folder }}" | perl -pe 's|^[^/]+||')
remaining_part=${remaining_part%/}
echo https://colab.research.google.com/github/${{ inputs.repo_owner }}/${{ inputs.package }}/blob/$branch$remaining_part
doc-builder notebook-to-mdx ${{ env.doc_folder }} --open_notebook_prefix https://colab.research.google.com/github/${{ inputs.repo_owner }}/${{ inputs.package }}/blob/$branch$remaining_part
- name: Make documentation
env:
NODE_OPTIONS: --max-old-space-size=6656
shell: bash
run: |
source .venv/bin/activate
echo "doc_folder has been set to ${{ env.doc_folder }}"
cd doc-builder
args="--build_dir ../build_dir --clean --version pr_${{ inputs.pr_number }} --html ${{ inputs.additional_args }} --repo_owner ${{ inputs.repo_owner }} --repo_name ${{ inputs.package }} --version_tag_suffix=${{ inputs.version_tag_suffix }}"
if [ -z "${{ inputs.languages }}" ];
then
echo "languages not provided, defaulting to English"
doc-builder build ${{ env.package_name }} ../${{ env.doc_folder }} $args
else
IFS=', ' read -r -a langs <<< "${{ inputs.languages }}"
for lang in "${langs[@]}"
do
echo "Generating docs for language $lang"
doc-builder build ${{ env.package_name }} ../${{ env.doc_folder }}/$lang $args --language $lang
done
fi
cd ..
- name: Save commit_sha & pr_number
run: |
echo ${{ inputs.commit_sha }} > ./build_dir/commit_sha
echo ${{ inputs.pr_number }} > ./build_dir/pr_number
- uses: actions/upload-artifact@v3
with:
name: doc-build-artifact
path: build_dir/