dpt-salsa(1) | Debian Perl packaging Tools | dpt-salsa(1) |
dpt-salsa - manage repositories and members of the perl-team on salsa.debian.org
dpt salsa [--help|--man|--json|--verbose|--all|--attic] subcommand [parameters]
dpt-salsa is basically a wrapper around GitLab::API::v4, similar to gitlab-api-v4(1), with various variables regarding salsa.debian.org and the modules subgroup of the perl-team group already preset and typical method calls encapsulated.
It offers subcommands to manage repositories and members of the modules subgroup with hopefully less typing then calling the API manually each time.
Make sure to check the "CONFIGURATION" section below if you use dpt-salsa for the first time.
pushrepo
Creates a new repository in the modules subgroup (with "createrepo()" and "configurerepo()") and pushes the local repository.
createrepo repositoryname
Creates a new empty repository in the modules subgroup and calls "configurerepo()".
Parameters:
configurerepo repositoryid|repositoryname [--verbose]
Sets up the default webhooks and services for one repository.
Parameters:
Silent on success unless "--verbose" is given.
configurerepo --all [--attic] [--verbose] [--parallel N] [-j N]
Sets up the default webhooks and services for all active (or, with "--attic", archived) repositories.
Silent on success unless "--verbose" is given.
With "--parallel" Parallel::ForkManager is employed for parallelism.
changerepo repositoryid|repositoryname "name"|"description" "parameter"
Changes the name (and the path) or the description of a repository.
Parameters:
listrepos [--json] [--attic]
Show all active (or, with "--attic", archived) repositories in the modules subgroup.
If used with "--all", returns repository ids and does not output anything; for internal use.
kgb repositoryid|repositoryname|--all [--attic] --on|--off
Install ("--on") or remove ("--off") the KGB IRC notification webhook for the given, all active ("--all"), or all archived ("--attic") repositories.
If a KGB notification webhook is already present, "--on" does nothing.
Parameters:
toattic|fromattic repositoryid|repositoryname
Moves a repository to/from the attic sub-group of the modules sub-group. Useful when a package is removed from the archive or added back.
Probably needs appropriate permissions.
adduser username|userid [access_level]
Adds a user to the modules subgroup of the perl-team group.
Parameters:
removeuser username|userid
Removes a user from the modules subgroup of the perl-team group.
Parameters:
changeuser access_level username|userid|--all
Change the access level of one or all user(s) in the modules subgroup of the perl-team group.
Parameters:
listmembers [--json]
Show all members of the modules subgroup of the perl-team group.
If used with "--all", returns user ids and does not output anything; for internal use.
mrconfig [--parallel N] [-j N]
Helper for creating
With "--parallel" Parallel::ForkManager is employed for parallelism.
Additionally, the option will also output a list of repositories that potentially have not been configured with dpt-salsa.
current_user [--json]
Outputs information about the user whose GitLab token is used.
help
Same as option --help.
version [--json]
Returns the version of the GitLab instance running on salsa.debian.org.
This subcommand is pretty useless, the only excuse for its existence is the ability to test if everything is working fine.
dpt-salsa uses the following environment variables, set either directly or via ~/.dpt.conf / ~/.config/dpt.conf:
These tokens are created at <https://salsa.debian.org/-/profile/personal_access_tokens>. Note that the token needs api and read_user scope permissions.
Cf. dpt-config(5).
By default, the output of some subcommands uses colors, unless STDOUT is not a tty or the environment variables CLICOLOR or NO_COLOR are set to false or true, respectively.
<https://salsa.debian.org/perl-team>
GitLab::API::v4
<https://docs.gitlab.com/ce/api/>
Copyright 2018-2022, gregor herrmann <gregoa@debian.org>
Released under the same terms as Perl itself, i.e. Artistic or GPL-1+.
2023-02-24 | pkg-perl-tools 0.75 |