[libcamera-ci,1/2] Add commit ref name to docs deployment log message
diff mbox series

Message ID 20260516202912.383234-2-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Small improvements to documentation deployment
Related show

Commit Message

Laurent Pinchart May 16, 2026, 8:29 p.m. UTC
Print the commit ref name in the log message to help troubleshooting.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 .gitlab-ci/deploy-libcamera-docs.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Pőcze Barnabás May 18, 2026, 7:55 a.m. UTC | #1
2026. 05. 16. 22:29 keltezéssel, Laurent Pinchart írta:
> Print the commit ref name in the log message to help troubleshooting.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>   .gitlab-ci/deploy-libcamera-docs.sh | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/.gitlab-ci/deploy-libcamera-docs.sh b/.gitlab-ci/deploy-libcamera-docs.sh
> index 2108858aabf8..639fdf748d07 100755
> --- a/.gitlab-ci/deploy-libcamera-docs.sh
> +++ b/.gitlab-ci/deploy-libcamera-docs.sh
> @@ -10,7 +10,7 @@ set -e
>   source "$(dirname "$0")/lib.sh"
> 
>   libcamera_deploy_docs() {
> -	echo "Deploying libcamera docs"
> +	echo "Deploying libcamera docs for ${CI_COMMIT_REF_NAME}"

As far as I can see $CI_COMMIT_REF_NAME is only the branch or tag name,
so I'm wondering if we should add e.g.

   ${CI_COMMIT_REF_NAME) (${CI_COMMIT_SHA})

?

Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>

> 
>   	rsync -rlz --delete --chmod=Do=rx,Fo=r \
>             --exclude .doctrees \
> --
> Regards,
> 
> Laurent Pinchart
>
Stefan Klug May 18, 2026, 8:17 a.m. UTC | #2
Hi Laurent,

Thank you for the patch.

Quoting Laurent Pinchart (2026-05-16 22:29:11)
> Print the commit ref name in the log message to help troubleshooting.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>

Cheers,
Stefan

> ---
>  .gitlab-ci/deploy-libcamera-docs.sh | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/.gitlab-ci/deploy-libcamera-docs.sh b/.gitlab-ci/deploy-libcamera-docs.sh
> index 2108858aabf8..639fdf748d07 100755
> --- a/.gitlab-ci/deploy-libcamera-docs.sh
> +++ b/.gitlab-ci/deploy-libcamera-docs.sh
> @@ -10,7 +10,7 @@ set -e
>  source "$(dirname "$0")/lib.sh"
>  
>  libcamera_deploy_docs() {
> -       echo "Deploying libcamera docs"
> +       echo "Deploying libcamera docs for ${CI_COMMIT_REF_NAME}"
>  
>         rsync -rlz --delete --chmod=Do=rx,Fo=r \
>            --exclude .doctrees \
> -- 
> Regards,
> 
> Laurent Pinchart
>
Laurent Pinchart May 18, 2026, 8:19 a.m. UTC | #3
On Mon, May 18, 2026 at 07:55:08AM +0000, Barnabás Pőcze wrote:
> 2026. 05. 16. 22:29 keltezéssel, Laurent Pinchart írta:
> > Print the commit ref name in the log message to help troubleshooting.
> > 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> >   .gitlab-ci/deploy-libcamera-docs.sh | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/.gitlab-ci/deploy-libcamera-docs.sh b/.gitlab-ci/deploy-libcamera-docs.sh
> > index 2108858aabf8..639fdf748d07 100755
> > --- a/.gitlab-ci/deploy-libcamera-docs.sh
> > +++ b/.gitlab-ci/deploy-libcamera-docs.sh
> > @@ -10,7 +10,7 @@ set -e
> >   source "$(dirname "$0")/lib.sh"
> > 
> >   libcamera_deploy_docs() {
> > -	echo "Deploying libcamera docs"
> > +	echo "Deploying libcamera docs for ${CI_COMMIT_REF_NAME}"
> 
> As far as I can see $CI_COMMIT_REF_NAME is only the branch or tag name,
> so I'm wondering if we should add e.g.
> 
>    ${CI_COMMIT_REF_NAME) (${CI_COMMIT_SHA})
> 
> ?

I added this message to debug issues where the doc wasn't deployed to
the right place, and I wondered if the commit ref name was right.
Obviously it turned out I was looking at the wrong directory on the
destination server, the issue wasn't on the CI side. We could drop this
patch if preferred, otherwise I'll add the commit SHA.

> Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>
> 
> > 
> >   	rsync -rlz --delete --chmod=Do=rx,Fo=r \
> >             --exclude .doctrees \

Patch
diff mbox series

diff --git a/.gitlab-ci/deploy-libcamera-docs.sh b/.gitlab-ci/deploy-libcamera-docs.sh
index 2108858aabf8..639fdf748d07 100755
--- a/.gitlab-ci/deploy-libcamera-docs.sh
+++ b/.gitlab-ci/deploy-libcamera-docs.sh
@@ -10,7 +10,7 @@  set -e
 source "$(dirname "$0")/lib.sh"
 
 libcamera_deploy_docs() {
-	echo "Deploying libcamera docs"
+	echo "Deploying libcamera docs for ${CI_COMMIT_REF_NAME}"
 
 	rsync -rlz --delete --chmod=Do=rx,Fo=r \
           --exclude .doctrees \