From patchwork Mon May 11 13:48:05 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Stefan Klug X-Patchwork-Id: 26712 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 5F9DDBDCBD for ; Mon, 11 May 2026 13:48:31 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 0ACBA6301E; Mon, 11 May 2026 15:48:31 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="l64FIojC"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id CB34163024 for ; Mon, 11 May 2026 15:48:27 +0200 (CEST) Received: from ideasonboard.com (unknown [IPv6:2a00:6020:448c:6c00:b16a:5ed9:4ada:a95a]) by perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id A0B67593; Mon, 11 May 2026 15:48:20 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1778507300; bh=4xXpRRXdhXgUDXNhGtEnYtg3xE1g5OBXnGJFH+BsFbg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=l64FIojClLIZu2lb/kjthuoOkUJw1MdoJpwIbniliT7LkZXJ/0P7FylBBqE4S3CjJ 2xxGbzVl8TgT0OqnBhdjxQuuo+v5Ft66krhO20xDA43osl8847Rtapx1EwFGTNQSN4 4OXo01n7hGnvEls2WmdgvlYUhvs5QrBeKUhsQBPE= From: Stefan Klug To: libcamera-devel@lists.libcamera.org Cc: Stefan Klug Subject: [PATCH v2 2/2] Deploy docs to docs.libcamera.org Date: Mon, 11 May 2026 15:48:05 +0200 Message-ID: <20260511134817.2841886-3-stefan.klug@ideasonboard.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20260511134817.2841886-1-stefan.klug@ideasonboard.com> References: <20260511134817.2841886-1-stefan.klug@ideasonboard.com> MIME-Version: 1.0 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Add a build step that deploys the docs to a server. This step only runs on pushes to master and on tag builds. It requires three external variables: DEPLOY_SSH_KEY_BASE64: base64 encoded private deploy key DEPLOY_KNOWN_HOSTS: Known hosts containing the destination DEPLOY_DESTINAION: user@host:/ for the rsync push Signed-off-by: Stefan Klug --- Changes in v2: - Moved deployment into script - Improved build rules - Pipe ssh key into ssh agent instead of creating a file --- .gitlab-ci/deploy-libcamera-docs.sh | 23 +++++++++++++++++++++++ .gitlab-ci/setup-container.sh | 2 ++ gitlab-ci.yml | 29 ++++++++++++++++++++++++++++- 3 files changed, 53 insertions(+), 1 deletion(-) create mode 100755 .gitlab-ci/deploy-libcamera-docs.sh diff --git a/.gitlab-ci/deploy-libcamera-docs.sh b/.gitlab-ci/deploy-libcamera-docs.sh new file mode 100755 index 000000000000..a6936728c4a9 --- /dev/null +++ b/.gitlab-ci/deploy-libcamera-docs.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# SPDX-License-Identifier: GPL-2.0-or-later +# SPDX-FileCopyrightText: © 2026 Ideas on Board +# +# Deploy libcamera docs + +set -e + +source "$(dirname "$0")/lib.sh" + +libcamera_deploy_docs() { + echo "Deploying libcamera docs" + + rsync -rlz --delete --chmod=Do=rx,Fo=r \ + --exclude .doctrees \ + --exclude .buildinfo \ + --exclude objects.inv \ + docs/ \ + "${DEPLOY_DESTINATION}${CI_COMMIT_REF_NAME}" +} + +run libcamera_deploy_docs diff --git a/.gitlab-ci/setup-container.sh b/.gitlab-ci/setup-container.sh index c7ca6426c3ab..6c4b439b887b 100755 --- a/.gitlab-ci/setup-container.sh +++ b/.gitlab-ci/setup-container.sh @@ -132,6 +132,8 @@ case $FDO_DISTRIBUTION_VERSION in python3-sphinxcontrib.doxylink texlive-latex-extra ) + # Packages required to deploy the documentation + PKGS_LIBCAMERA_RUNTIME+=( openssh-client rsync ) # Tools requires by the lint jobs. PKGS_LIBCAMERA_RUNTIME+=( clang-format jq python3-autopep8 reuse shellcheck ) # libclang-rt-dev for the clang ASan runtime. diff --git a/gitlab-ci.yml b/gitlab-ci.yml index 7c5e59de30a1..cef5a16de20a 100644 --- a/gitlab-ci.yml +++ b/gitlab-ci.yml @@ -5,6 +5,7 @@ stages: - build - lint - test + - deploy variables: FDO_UPSTREAM_REPO: 'camera/libcamera' @@ -74,7 +75,7 @@ include: .libcamera-ci.debian:13: variables: FDO_DISTRIBUTION_VERSION: 'trixie' - FDO_DISTRIBUTION_TAG: '2026-04-24.0' + FDO_DISTRIBUTION_TAG: '2026-05-06.0' .container-debian: extends: @@ -438,3 +439,29 @@ test-lc-compliance:virtual: artifacts: reports: junit: build/lc-compliance-report.xml + +# ------------------------------------------------------------------------------ +# Deploy stage - deploy docs if we are building master or a tag +# ------------------------------------------------------------------------------ + +deploy-docs: + extends: + - .fdo.distribution-image@debian + - .libcamera-ci.debian:13 + - .libcamera-ci.scripts + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + - if: $CI_COMMIT_TAG =~ /^v([0-9]+\.)*[0-9]+$/ + environment: deploy + stage: deploy + needs: + - job: build-docs + script: + - | + mkdir -p ~/.ssh + chmod 700 ~/.ssh + echo "${DEPLOY_KNOWN_HOSTS}" > ~/.ssh/known_hosts + eval $(ssh-agent -s) + echo "${DEPLOY_SSH_KEY_BASE64}" | base64 -d | ssh-add - + + - $CI_PROJECT_DIR/.gitlab-ci/deploy-libcamera-docs.sh