Skip to content

Commit

Permalink
Update base image for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
laurentgo committed Jun 13, 2024
1 parent 28a897a commit 1814e34
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 34 deletions.
11 changes: 6 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,13 @@ env:
jobs:

complete:
name: AMD64 Debian 12 Complete Documentation
name: AMD64 Ubuntu 24.04 Complete Documentation
runs-on: ubuntu-latest
if: ${{ !contains(github.event.pull_request.title, 'WIP') }}
timeout-minutes: 150
env:
JDK: 21
UBUNTU: 24.04
steps:
- name: Checkout Arrow
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
Expand All @@ -50,8 +51,8 @@ jobs:
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
with:
path: .docker
key: debian-docs-${{ hashFiles('cpp/**') }}
restore-keys: debian-docs-
key: ubuntu-docs-${{ hashFiles('cpp/**') }}
restore-keys: ubuntu-docs-
- name: Setup Python
uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
with:
Expand All @@ -63,7 +64,7 @@ jobs:
ARCHERY_DOCKER_USER: ${{ secrets.DOCKERHUB_USER }}
ARCHERY_DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
JDK: 21
run: archery docker run debian-docs
run: archery docker run ubuntu-docs
- name: Docker Push
if: >-
success() &&
Expand All @@ -74,4 +75,4 @@ jobs:
ARCHERY_DOCKER_USER: ${{ secrets.DOCKERHUB_USER }}
ARCHERY_DOCKER_PASSWORD: ${{ secrets.DOCKERHUB_TOKEN }}
continue-on-error: true
run: archery docker push debian-docs
run: archery docker push ubuntu-docs
18 changes: 7 additions & 11 deletions ci/docker/linux-apt-docs.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,18 @@ ARG jdk=8

ENV PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium

# See R install instructions at https://cloud.r-project.org/bin/linux/
# See R install instructions at https://cloud.r-project.org/bin/linux/ubuntu
RUN apt-get update -y && \
apt-get install -y \
apt-transport-https \
software-properties-common \
dirmngr \
gpg \
lsb-release && \
gpg --keyserver keyserver.ubuntu.com \
--recv-key 95C0FAF38DB3CCAD0C080A7BDC78B2DDEABC47B7 && \
gpg --export 95C0FAF38DB3CCAD0C080A7BDC78B2DDEABC47B7 | \
gpg --no-default-keyring \
--keyring /usr/share/keyrings/cran.gpg \
--import - && \
echo "deb [signed-by=/usr/share/keyrings/cran.gpg] https://cloud.r-project.org/bin/linux/$(lsb_release -is | tr 'A-Z' 'a-z') $(lsb_release -cs)-cran40/" | \
tee /etc/apt/sources.list.d/cran.list && \
wget -qO- https://cloud.r-project.org/bin/linux/ubuntu/marutter_pubkey.asc | \
tee -a /etc/apt/trusted.gpg.d/cran_ubuntu_key.asc && \
# NOTE: Only R >= 4.0 is available in this repo
add-apt-repository 'deb https://cloud.r-project.org/bin/linux/ubuntu '$(lsb_release -cs)'-cran40/' && \
if [ -f /etc/apt/sources.list.d/debian.sources ]; then \
sed -i \
-e 's/main$/main contrib non-free non-free-firmware/g' \
Expand All @@ -47,8 +44,7 @@ RUN apt-get update -y && \
apt-get install -y --no-install-recommends \
autoconf-archive \
automake \
chromium \
chromium-sandbox \
chromium-browser \
curl \
doxygen \
gi-docgen \
Expand Down
14 changes: 8 additions & 6 deletions dev/tasks/tasks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ groups:
- r-binary-packages
- ubuntu-*
- wheel-*
- test-debian-*-docs
- test-ubuntu-*-docs

{############################# Testing tasks #################################}

Expand Down Expand Up @@ -1446,15 +1446,16 @@ tasks:
{% endfor %}

# be sure to update binary-task.rb when upgrading ubuntu
test-debian-12-docs:
test-ubuntu-24.04-docs:
ci: github
template: docs/github.linux.yml
params:
env:
JDK: 17
JDK: 21
UBUNTU: 24.04
pr_number: Unset
flags: "-v $PWD/build/:/build/"
image: debian-docs
image: ubuntu-docs
publish: false
artifacts:
- docs.tar.gz
Expand Down Expand Up @@ -1582,8 +1583,9 @@ tasks:
template: docs/github.linux.yml
params:
env:
JDK: 17
JDK: 21
UBUNTU: 24.04
pr_number: Unset
flags: "-v $PWD/build/:/build/"
image: debian-docs
image: ubuntu-docs
publish: true
24 changes: 12 additions & 12 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,7 @@ x-hierarchy:
- debian-cpp:
- debian-c-glib:
- debian-ruby
- debian-python:
- debian-docs
- debian-python
- debian-go:
- debian-go-cgo
- debian-go-cgo-python
Expand All @@ -146,7 +145,8 @@ x-hierarchy:
- ubuntu-c-glib:
- ubuntu-ruby
- ubuntu-lint
- ubuntu-python
- ubuntu-python:
- ubuntu-docs
- ubuntu-python-sdist-test
- ubuntu-r
- ubuntu-r-only-r
Expand Down Expand Up @@ -1762,24 +1762,24 @@ services:

################################ Docs #######################################

debian-docs:
ubuntu-docs:
# Usage:
# docker-compose build debian-cpp
# docker-compose build debian-python
# docker-compose build debian-docs
# docker-compose run --rm debian-docs
image: ${REPO}:${ARCH}-debian-${DEBIAN}-docs
# docker-compose build ubuntu-cpp
# docker-compose build ubuntu-python
# docker-compose build ubuntu-docs
# docker-compose run --rm ubuntu-docs
image: ${REPO}:${ARCH}-ubuntu-${UBUNTU}-docs
build:
context: .
dockerfile: ci/docker/linux-apt-docs.dockerfile
cache_from:
- ${REPO}:${ARCH}-debian-${DEBIAN}-docs
- ${REPO}:${ARCH}-ubuntu-${UBUNTU}-docs
args:
r: ${R}
jdk: ${JDK}
maven: ${MAVEN}
node: ${NODE}
base: ${REPO}:${ARCH}-debian-${DEBIAN}-python-3
base: ${REPO}:${ARCH}-ubuntu-${UBUNTU}-python-3
# This is for Chromium used by Mermaid. Chromium uses namespace
# isolation for security by default.
cap_add:
Expand All @@ -1798,7 +1798,7 @@ services:
BUILD_DOCS_JS: "ON"
BUILD_DOCS_PYTHON: "ON"
BUILD_DOCS_R: "ON"
volumes: *debian-volumes
volumes: *ubuntu-volumes
command: >
/bin/bash -c "
sudo mkdir -p /build /ccache &&
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ sphinx-lint
sphinxcontrib-mermaid
sphinx==6.2
pandas
pickle5
1 change: 1 addition & 0 deletions docs/source/python/getstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ Loading back the partitioned dataset will detect the chunks
and will lazily load chunks of data only when iterating over them

.. ipython:: python
:suppress:
import datetime
Expand Down

0 comments on commit 1814e34

Please sign in to comment.