Skip to content

Commit be9a22b

Browse files
kszucskou
andcommitted
ARROW-14505: [CI][Docs] Exercise documentation builds more frequently
Closes #11567 from kszucs/build-docs-on-main-branch Lead-authored-by: Krisztián Szűcs <[email protected]> Co-authored-by: Sutou Kouhei <[email protected]> Signed-off-by: Krisztián Szűcs <[email protected]>
1 parent 55ebeb3 commit be9a22b

18 files changed

Lines changed: 268 additions & 179 deletions

‎.github/workflows/docs.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
name: Docs
19+
20+
on:
21+
push:
22+
pull_request:
23+
paths:
24+
- '.github/workflows/docs.yml'
25+
- 'ci/docker/linux-apt-docs.dockerfile'
26+
- 'ci/docker/linux-apt-python-3.dockerfile'
27+
- 'ci/docker/ubuntu-20.04-cpp.dockerfile'
28+
- 'ci/scripts/c_glib_build.sh'
29+
- 'ci/scripts/cpp_build.sh'
30+
- 'ci/scripts/docs_build.sh'
31+
- 'ci/scripts/java_build.sh'
32+
- 'ci/scripts/js_build.sh'
33+
- 'ci/scripts/python_build.sh'
34+
- 'ci/scripts/r_build.sh'
35+
36+
env:
37+
ARROW_ENABLE_TIMING_TESTS: OFF
38+
DOCKER_VOLUME_PREFIX: ".docker/"
39+
ARCHERY_DOCKER_USER: ${{ secrets.DOCKERHUB_USER }}
40+
ARCHERY_DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
41+
42+
jobs:
43+
44+
docker:
45+
name: AMD64 Ubuntu 20.04 Complete Documentation
46+
runs-on: ubuntu-latest
47+
if: ${{ !contains(github.event.pull_request.title, 'WIP') }}
48+
timeout-minutes: 150
49+
env:
50+
UBUNTU: "20.04"
51+
steps:
52+
- name: Checkout Arrow
53+
uses: actions/checkout@v2
54+
with:
55+
fetch-depth: 0
56+
- name: Fetch Submodules and Tags
57+
run: ci/scripts/util_checkout.sh
58+
- name: Free Up Disk Space
59+
run: ci/scripts/util_cleanup.sh
60+
- name: Cache Docker Volumes
61+
uses: actions/cache@v2
62+
with:
63+
path: .docker
64+
key: ubuntu-docs-${{ hashFiles('cpp/**') }}
65+
restore-keys: ubuntu-docs-
66+
- name: Setup Python
67+
uses: actions/setup-python@v2
68+
with:
69+
python-version: 3.8
70+
- name: Setup Archery
71+
run: pip install -e dev/archery[docker]
72+
- name: Execute Docker Build
73+
run: archery docker run ubuntu-docs
74+
- name: Docker Push
75+
if: success() && github.event_name == 'push' && github.repository == 'apache/arrow'
76+
continue-on-error: true
77+
run: archery docker push ubuntu-docs

‎.github/workflows/ruby.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
name: AMD64 Ubuntu ${{ matrix.ubuntu }} GLib & Ruby
5959
runs-on: ubuntu-latest
6060
if: ${{ !contains(github.event.pull_request.title, 'WIP') }}
61-
timeout-minutes: 40
61+
timeout-minutes: 60
6262
strategy:
6363
fail-fast: false
6464
matrix:

‎ci/conda_env_sphinx.txt‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
breathe
2020
doxygen
2121
ipython
22-
sphinx=4.2
22+
sphinx>=4.2
2323
pydata-sphinx-theme
24-
sphinx-tabs
24+
25+
# Unable to install sphinx-tabs from conda-forge due to:
26+
# - package sphinx-tabs-1.2.1-py_0 requires sphinx >=2,<4, but none of the providers can be installed
27+
# sphinx-tabs

‎ci/docker/conda-python.dockerfile‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,21 @@ FROM ${repo}:${arch}-conda-cpp
2121

2222
# install python specific packages
2323
ARG python=3.6
24-
COPY ci/conda_env_python.txt /arrow/ci/
24+
COPY ci/conda_env_python.txt \
25+
ci/conda_env_sphinx.txt \
26+
/arrow/ci/
2527
RUN mamba install -q \
2628
--file arrow/ci/conda_env_python.txt \
29+
--file arrow/ci/conda_env_sphinx.txt \
2730
$([ "$python" == "3.6" -o "$python" == "3.7" ] && echo "pickle5") \
2831
python=${python} \
2932
nomkl && \
3033
mamba clean --all
3134

35+
# unable to install from conda-forge due to sphinx version pin, see comment in
36+
# arrow/ci/conda_env_sphinx.txt
37+
RUN pip install sphinx-tabs
38+
3239
ENV ARROW_PYTHON=ON \
3340
ARROW_BUILD_STATIC=OFF \
3441
ARROW_BUILD_TESTS=OFF \

‎ci/docker/debian-10-js.dockerfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ FROM ${arch}/node:${node}
2121

2222
ENV NODE_NO_WARNINGS=1
2323

24+
# install rsync for copying the generated documentation
25+
RUN apt-get update -y -q && \
26+
apt-get install -y -q --no-install-recommends rsync && \
27+
apt-get clean && \
28+
rm -rf /var/lib/apt/lists/*
29+
2430
# TODO(kszucs):
2531
# 1. add the files required to install the dependencies to .dockerignore
2632
# 2. copy these files to their appropriate path

‎ci/docker/debian-11-js.dockerfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ FROM ${arch}/node:${node}
2121

2222
ENV NODE_NO_WARNINGS=1
2323

24+
# install rsync for copying the generated documentation
25+
RUN apt-get update -y -q && \
26+
apt-get install -y -q --no-install-recommends rsync && \
27+
apt-get clean && \
28+
rm -rf /var/lib/apt/lists/*
29+
2430
# TODO(kszucs):
2531
# 1. add the files required to install the dependencies to .dockerignore
2632
# 2. copy these files to their appropriate path

‎ci/docker/linux-apt-docs.dockerfile‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,13 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
7474
rm -rf /var/lib/apt/lists/* && \
7575
npm install -g yarn
7676

77-
# ARROW-13353: breathe >= 4.29.1 tries to parse template arguments,
78-
# but Sphinx can't parse constructs like `typename...`.
7977
RUN pip install \
80-
meson \
81-
breathe==4.29.0 \
78+
breathe \
8279
ipython \
80+
meson \
8381
pydata-sphinx-theme \
84-
sphinx \
85-
sphinx-tabs
82+
sphinx-tabs \
83+
sphinx>=4.2
8684

8785
COPY c_glib/Gemfile /arrow/c_glib/
8886
RUN gem install --no-document bundler && \
@@ -107,4 +105,4 @@ ENV ARROW_FLIGHT=ON \
107105
ARROW_BUILD_TESTS=OFF \
108106
ARROW_BUILD_UTILITIES=OFF \
109107
ARROW_USE_GLOG=OFF \
110-
CMAKE_UNITY_BUILD=ON \
108+
CMAKE_UNITY_BUILD=ON

‎ci/docker/ubuntu-18.04-cpp.dockerfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ RUN apt-get update -y -q && \
8383
pkg-config \
8484
protobuf-compiler \
8585
rapidjson-dev \
86+
rsync \
8687
tzdata && \
8788
apt-get clean && \
8889
rm -rf /var/lib/apt/lists*

‎ci/docker/ubuntu-20.04-cpp.dockerfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ RUN apt-get update -y -q && \
9999
python3-rados \
100100
rados-objclass-dev \
101101
rapidjson-dev \
102+
rsync \
102103
tzdata \
103104
wget && \
104105
apt-get clean && \

‎ci/docker/ubuntu-21.04-cpp.dockerfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ RUN apt-get update -y -q && \
9696
protobuf-compiler-grpc \
9797
python3-pip \
9898
rapidjson-dev \
99+
rsync \
99100
tzdata \
100101
wget && \
101102
apt-get clean && \

0 commit comments

Comments
 (0)