Debian Bug report logs - #1009339
python-gitlab: reproducible builds: build year embedded in documentation

Toggle useless messages

Message #5 received at submit@bugs.debian.org (full text, mbox, reply):

From: Vagrant Cascadian <vagrant@reproducible-builds.org>

To: submit@bugs.debian.org

Subject: python-gitlab: reproducible builds: build year embedded in documentation

Date: Mon, 11 Apr 2022 17:07:24 -0700

[Message part 1 (text/plain, inline)]

Source: python-gitlab
Severity: normal
Tags: patch
User: reproducible-builds@lists.alioth.debian.org
Usertags: timestamps
X-Debbugs-Cc: reproducible-bugs@lists.alioth.debian.org

The year of the build is embedded in various documentation:

  https://tests.reproducible-builds.org/debian/rb-pkg/unstable/amd64/python-gitlab.html

  /usr/share/doc/python-gitlab-doc/html/api/gitlab.v4.html

  2018-2023,·python-gitlab·team.
  vs.
  2018-2022,·python-gitlab·team.


The attached patch fixes this by adjusting doc/conf.py to use the
SOURCE_DATE_EPOCH environment variable to determine the date to use for
the year.


With this patch applied, python-gitlab should build reproducibly on
tests.reproducible-builds.org again!


Thanks for maintaining python-gitlab!


live well,
  vagrant

[0001-doc-conf.py-Support-SOURCE_DATE_EPOCH-to-set-year.patch (text/x-diff, inline)]

From 89eea6707eb16e4a5403419ac105f94a992abb64 Mon Sep 17 00:00:00 2001
From: Vagrant Cascadian <vagrant@reproducible-builds.org>
Date: Mon, 11 Apr 2022 23:57:38 +0000
Subject: [PATCH] doc/conf.py: Support SOURCE_DATE_EPOCH to set year.

Without this, the documentation may contain a different copyright year
depending on when it was built.

https://reproducible-builds.org/docs/source-date-epoch/
---
 docs/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index 490f16f..c04d871 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -18,13 +18,14 @@ from __future__ import unicode_literals
 import os
 import sys
 from datetime import datetime
+from time import time
 
 sys.path.append("../")
 sys.path.append(os.path.dirname(__file__))
 import gitlab  # noqa: E402. Needed purely for readthedocs' build
 
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
-year = datetime.now().year
+year = datetime.utcfromtimestamp(int(os.environ.get('SOURCE_DATE_EPOCH', time()))).year
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
-- 
2.30.2

[signature.asc (application/pgp-signature, inline)]

Message #10 received at 1009339-close@bugs.debian.org (full text, mbox, reply):

From: Debian FTP Masters <ftpmaster@ftp-master.debian.org>

To: 1009339-close@bugs.debian.org

Subject: Bug#1009339: fixed in python-gitlab 1:3.5.0-1

Date: Sat, 11 Jun 2022 13:12:32 +0000

Source: python-gitlab
Source-Version: 1:3.5.0-1
Done: Federico Ceratto <federico@debian.org>

We believe that the bug you reported is fixed in the latest version of
python-gitlab, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 1009339@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Federico Ceratto <federico@debian.org> (supplier of updated python-gitlab package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 1.8
Date: Sat, 11 Jun 2022 13:28:19 +0100
Source: python-gitlab
Architecture: source
Version: 1:3.5.0-1
Distribution: unstable
Urgency: medium
Maintainer: Federico Ceratto <federico@debian.org>
Changed-By: Federico Ceratto <federico@debian.org>
Closes: 1009339
Changes:
 python-gitlab (1:3.5.0-1) unstable; urgency=medium
 .
   * New upstream release
   * Fix reproducible building documentation (Closes: #1009339)
     Kudos to Vagrant Cascadian
Checksums-Sha1:
 276b0ab5f96bb2d84c390e1e5943267b2aebce10 2291 python-gitlab_3.5.0-1.dsc
 5eb52516c1d6c5d73306ae75d59ddb677b14bb7b 221901 python-gitlab_3.5.0.orig.tar.gz
 f2181e0e67030ef626e2c345cecbf7f6303623ab 5140 python-gitlab_3.5.0-1.debian.tar.xz
 aa9da1c9e2355621f522faeb676a8031788ff9f9 8827 python-gitlab_3.5.0-1_amd64.buildinfo
Checksums-Sha256:
 16f78d7c345130442fb46dca4c42eb9c5271997d44e29a211b248c1a4945ee1e 2291 python-gitlab_3.5.0-1.dsc
 d2e12bf2763af946aed1dc5566b33d2e4bfe9a6770fc5fdf2f9e149b692a0914 221901 python-gitlab_3.5.0.orig.tar.gz
 3735759213c049d5eaec5abeafb50ae6ad8a85b3ed5058841ce4b4a170cde54c 5140 python-gitlab_3.5.0-1.debian.tar.xz
 6996f9bcb60cb97b49e90b6632e8328157364d9508e822760530ce98f2db7bb1 8827 python-gitlab_3.5.0-1_amd64.buildinfo
Files:
 3a0a3319773d14882f29e6054bd6a014 2291 python optional python-gitlab_3.5.0-1.dsc
 39450f64462d3cfa8027acf524f1f221 221901 python optional python-gitlab_3.5.0.orig.tar.gz
 f1eb679d3ac02471702357644e7f50ec 5140 python optional python-gitlab_3.5.0-1.debian.tar.xz
 cb18d0a3d3cc9fd5442154d820043c75 8827 python optional python-gitlab_3.5.0-1_amd64.buildinfo

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEfKfd+zM5IUCMbyuWbzG8RPUXfaoFAmKkjOoACgkQbzG8RPUX
fapDvA//YuAHbLzRvjDAcy2YLaQg1oSTTyddn1P6UHLBJCvDng1PyJeg8+zeXn47
sGQK/oFbLIpSHGGKY8eooq5uFI98T+ju6sLewqNNiszUV43TlRYlIvA2oV0aN+is
Q+RwmSz1CEC7l4kHqjKmZt9QZtUG1IEzDeSeFdw6h9mDdC/454EXCf+nlaevcUo2
S3/YJPQmwqpNkhCvUciCwkVw3OoKTYNRikyroDpVy9y2NzMu7kJqU58PgB9jPDaw
x+quhQ7IyG2jYuwEmAIHemBU4Sm6zaJhR8shPvzYB+K0/Mg84zN6DfqJ8p6UTTdD
Imivr0GqHbrrTjiazlNYEXGqHUBmlvakNSh3Kh457oI8cVOiCD8lTbURPSJ5Wsdc
YHUdnyw/vFkd91IBjN75TWzMqJthcaJ6YVLihEZ8wDke+3xcCqMx0TAM765X0LuW
goiUAg9XR43Xr/jov8gJgPuG+N7ef5WfnrrEPsGrA3Za9i1KLgN02EHoCiRnI8Gr
WNdQ1uma8RaHXKXPWShviHzlCeLzXL+0ta9LiBAFwjLx9wWptVrbWb+uycsuEbuz
F34Vo08UUiaOseCz9lPY8l7PKxoh0pfVJuxoK3QFaRazTZHpm7Ct9z0EGmB9Q/qO
8PuBY5CSJlTYavQ8RArrhsxuSGbRMtLK6XWgk1Zg+XuMACaIECM=
=JrvK
-----END PGP SIGNATURE-----

Send a report that this bug log contains spam.