summaryrefslogtreecommitdiffstats
path: root/wiki/src
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2020-11-20 07:38:31 +0000
committerintrigeri <intrigeri@boum.org>2020-11-20 07:38:31 +0000
commitcd0c829d135d6b68708aba753d64954928f6cee3 (patch)
tree303f3fbf52c5f1dad0e66c3a2075e2cfcffe1e45 /wiki/src
parenta14ddec651c022dd876f201ff47490ce57b81c6a (diff)
parent75b7cf35e789dd22865857f920b9f815534ebe8e (diff)
Merge branch 'doc/18009-python-gitlab-setup' into 'master'
Document python-gitlab setup needed for generate-changelog and generate-report See merge request tails/tails!258
Diffstat (limited to 'wiki/src')
-rw-r--r--wiki/src/contribute/working_together/GitLab.mdwn36
1 files changed, 36 insertions, 0 deletions
diff --git a/wiki/src/contribute/working_together/GitLab.mdwn b/wiki/src/contribute/working_together/GitLab.mdwn
index be98d1b..9b31114 100644
--- a/wiki/src/contribute/working_together/GitLab.mdwn
+++ b/wiki/src/contribute/working_together/GitLab.mdwn
@@ -405,6 +405,42 @@ you can:
See [[!tails_gitlab help/user/project/issues/managing_issues.html#new-issue-via-email desc="New issue via email"]]
in the GitLab documentation.
+<a id="api"></a>
+
+# Scripts that use the GitLab API
+
+We have several scripts that query or manipulate data using the GitLab API:
+for example, [[!tails_gitweb bin/generate-changelog]] and [[!tails_gitweb
+bin/generate-report]].
+
+To use them:
+
+* Install a recent enough `python3-gitlab` Debian package:
+
+ if [ "$(lsb_release --short --codename)" = buster ]; then
+ sudo apt install python3-gitlab/bullseye
+ else
+ sudo apt install python3-gitlab
+ fi
+
+* Configure your `~/.python-gitlab.cfg`.
+
+ You need at least this content:
+
+ [global]
+ ssl_verify = true
+
+ [Tails]
+ url = https://gitlab.tails.boum.org
+ per_page = 100
+ private_token = XXX
+
+ In the `Tails` section, set the value of the `private_token` option to a
+ GitLab API token for your own user. To generate such a token,
+ visit [[!tails_gitlab profile/personal_access_tokens]].
+
+* If you are working from Tails, run the scripts using `torsocks`.
+
<a id="core-work"></a>
# Core teams' work