Commit cd0c829d authored by intrigeri's avatar intrigeri
Browse files

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
parents a14ddec6 75b7cf35
#! /usr/bin/python3
# Documentation: https://tails.boum.org/contribute/working_together/GitLab/#api
import datetime
import email.utils
import functools
......
#! /usr/bin/python3
# Documentation: https://tails.boum.org/contribute/working_together/GitLab/#api
import functools
import sys
import logging
......
......@@ -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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment