.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "dpt-salsa 1"
.TH dpt-salsa 1 2024-03-04 "pkg-perl-tools 0.78" "Debian Perl packaging Tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
dpt\-salsa \- manage repositories and members of the perl\-team on salsa.debian.org
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBdpt salsa\fR [\-\-help|\-\-man|\-\-json|\-\-verbose|\-\-all|\-\-attic] \fIsubcommand\fR [parameters]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdpt-salsa\fR is basically a wrapper around GitLab::API::v4, similar to
\&\fBgitlab\-api\-v4\fR\|(1), with various variables regarding \fIsalsa.debian.org\fR
and the \fImodules\fR subgroup of the \fIperl-team\fR group already preset and
typical method calls encapsulated.
.PP
It offers subcommands to manage repositories and members of the \fImodules\fR
subgroup with hopefully less typing then calling the API manually each time.
.PP
Make sure to check the "CONFIGURATION" section below if you use
\&\fBdpt-salsa\fR for the first time.
.SH SUBCOMMANDS
.IX Header "SUBCOMMANDS"
.SS "for managing repositories"
.IX Subsection "for managing repositories"
\fIpushrepo\fR
.IX Subsection "pushrepo"
.PP
Creates a new repository in the \fImodules\fR subgroup (with \f(CWcreaterepo()\fR and
\&\f(CWconfigurerepo()\fR) and pushes the local repository.
.PP
\fIcreaterepo repositoryname\fR
.IX Subsection "createrepo repositoryname"
.PP
Creates a new empty repository in the \fImodules\fR subgroup and calls \f(CWconfigurerepo()\fR.
.PP
Parameters:
.IP repositoryname 4
.IX Item "repositoryname"
Name of the repository to be added; usually the package name.
Required.
.PP
\fIconfigurerepo repositoryid|repositoryname [\-\-verbose]\fR
.IX Subsection "configurerepo repositoryid|repositoryname [--verbose]"
.PP
Sets up the default webhooks and services for one repository.
.PP
Parameters:
.IP repositoryid|repositoryname 4
.IX Item "repositoryid|repositoryname"
The repository to be configured. Either its id (\ed+) or name (\ew+).
Required.
.PP
Silent on success unless \f(CW\*(C`\-\-verbose\*(C'\fR is given.
.PP
\fIconfigurerepo \-\-all [\-\-attic] [\-\-verbose] [\-\-parallel N] [\-j N]\fR
.IX Subsection "configurerepo --all [--attic] [--verbose] [--parallel N] [-j N]"
.PP
Sets up the default webhooks and services for all active (or, with
\&\f(CW\*(C`\-\-attic\*(C'\fR, archived) repositories.
.PP
Silent on success unless \f(CW\*(C`\-\-verbose\*(C'\fR is given.
.PP
With \f(CW\*(C`\-\-parallel\*(C'\fR Parallel::ForkManager is employed for parallelism.
.PP
\fIchangerepo repositoryid|repositoryname "name"|"description" \fR\f(CI"parameter"\fR
.IX Subsection "changerepo repositoryid|repositoryname ""name""|""description"" ""parameter"""
.PP
Changes the name (and the path) or the description of a repository.
.PP
Parameters:
.IP repositoryid|repositoryname 4
.IX Item "repositoryid|repositoryname"
The repository to be configured. Either its id (\ed+) or name (\ew+).
Required.
.IP """name""|""description""" 4
.IX Item """name""|""description"""
What should be changed? The "name" or the "description" of the repository.
Required.
.IP parameter 4
.IX Item "parameter"
The new name or description.
Required.
.PP
\fIlistrepos [\-\-json] [\-\-attic]\fR
.IX Subsection "listrepos [--json] [--attic]"
.PP
Show all active (or, with \f(CW\*(C`\-\-attic\*(C'\fR, archived) repositories in the
\&\fImodules\fR subgroup.
.PP
If used with \f(CW\*(C`\-\-all\*(C'\fR, returns repository ids and does not output anything;
for internal use.
.PP
\fIkgb repositoryid|repositoryname|\-\-all [\-\-attic] \-\-on|\-\-off\fR
.IX Subsection "kgb repositoryid|repositoryname|--all [--attic] --on|--off"
.PP
Install (\f(CW\*(C`\-\-on\*(C'\fR) or remove (\f(CW\*(C`\-\-off\*(C'\fR) the KGB IRC notification webhook
for the given, all active (\f(CW\*(C`\-\-all\*(C'\fR), or all
archived (\f(CW\*(C`\-\-attic\*(C'\fR) repositories.
.PP
\&\f(CW\*(C`\-\-on\*(C'\fR removes any legacy hooks (plain http, explicit port number) and
replaces them with the canonical one. If the repository already uses the right
hook, \f(CW\*(C`\-\-on\*(C'\fR does nothing.
.PP
Parameters:
.IP repositoryid|repositoryname 4
.IX Item "repositoryid|repositoryname"
The repository to be configured. Either its id (\ed+) or name (\ew+).
Required unless \f(CW\*(C`\-\-all\*(C'\fR is used.
.PP
\fItoattic|fromattic repositoryid|repositoryname\fR
.IX Subsection "toattic|fromattic repositoryid|repositoryname"
.PP
Moves a repository to/from the \fIattic\fR sub-group of the \fImodules\fR sub-group.
Useful when a package is removed from the archive or added back.
.PP
Probably needs appropriate permissions.
.SS "for managing users"
.IX Subsection "for managing users"
\fIadduser username|userid [access_level]\fR
.IX Subsection "adduser username|userid [access_level]"
.PP
Adds a user to the \fImodules\fR subgroup of the \fIperl-team\fR group.
.PP
Parameters:
.IP username|userid 4
.IX Item "username|userid"
The user to be added. Either their id (\ed+) or their username (\ew+).
Required.
.IP access_level 4
.IX Item "access_level"
One of \fIGitLab\fR's access levels: no_access, guest, reporter, developer, maintainer, owner.
Optional, defaults to \f(CW\*(C`maintainer\*(C'\fR.
.PP
\fIremoveuser username|userid\fR
.IX Subsection "removeuser username|userid"
.PP
Removes a user from the \fImodules\fR subgroup of the \fIperl-team\fR group.
.PP
Parameters:
.IP username|userid 4
.IX Item "username|userid"
The user to be removed. Either their id (\ed+) or their username (\ew+).
Required.
.PP
\fIchangeuser access_level username|userid|\-\-all\fR
.IX Subsection "changeuser access_level username|userid|--all"
.PP
Change the access level of one or all user(s) in the \fImodules\fR subgroup of the
\&\fIperl-team\fR group.
.PP
Parameters:
.IP access_level 4
.IX Item "access_level"
One of \fIGitLab\fR's access levels: guest, reporter, developer, maintainer, owner.
Required.
.IP username|userid 4
.IX Item "username|userid"
The user whose access level is to be changed. Either their id (\ed+) or their
username (\ew+).
Required, unless \f(CW\*(C`\-\-all\*(C'\fR is used.
.PP
\fIlistmembers [\-\-json]\fR
.IX Subsection "listmembers [--json]"
.PP
Show all members of the \fImodules\fR subgroup of the \fIperl-team\fR group.
.PP
If used with \f(CW\*(C`\-\-all\*(C'\fR, returns user ids and does not output anything; for
internal use.
.SS others
.IX Subsection "others"
\fImrconfig [\-\-parallel N] [\-j N]\fR
.IX Subsection "mrconfig [--parallel N] [-j N]"
.PP
Helper for creating
.IP \(bu 4
a \fI.mrconfig.packages\fR file in the local clone of
\&\f(CW\*(C`meta.git\*(C'\fR for all active packages of the \fImodules\fR subgroup of the
\&\fIperl-team\fR group. Also writes to stdout which can be included from
\&\fI.mrconfig\fR.
.IP \(bu 4
\&\fI.lastactivity/PKGNAME\fR files in the local clone of
\&\f(CW\*(C`meta.git\*(C'\fR for all active packages of the \fImodules\fR subgroup of the
\&\fIperl-team\fR group which are then used by \fBcompare-lastactivity\fR in \fI.mrconfig\fR.
.PP
With \f(CW\*(C`\-\-parallel\*(C'\fR Parallel::ForkManager is employed for parallelism.
.PP
Additionally, the option will also output a list of repositories
that potentially have not been configured with \fBdpt-salsa\fR.
.PP
\fIcurrent_user [\-\-json]\fR
.IX Subsection "current_user [--json]"
.PP
Outputs information about the user whose \fIGitLab\fR token is used.
.PP
\fIhelp\fR
.IX Subsection "help"
.PP
Same as option \fI\-\-help\fR.
.PP
\fIversion [\-\-json]\fR
.IX Subsection "version [--json]"
.PP
Returns the version of the \fIGitLab\fR instance running on \fIsalsa.debian.org\fR.
.PP
This subcommand is pretty useless, the only excuse for its existence is the
ability to test if everything is working fine.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \-\-help 4
.IX Item "--help"
Show short help.
.IP \-\-man 4
.IX Item "--man"
Show complete manpage.
.IP \-\-all 4
.IX Item "--all"
Act on all users or repositories, not a single named one.
Only for specific subcommands, as noted in their description.
.IP \-\-attic 4
.IX Item "--attic"
Act on archived repositories instead of active ones.
Only for specific subcommands, as noted in their description.
.IP \-\-json 4
.IX Item "--json"
Format output as JSON instead of human-targeted text.
Only for specific subcommands, as noted in their description.
.IP \-\-verbose 4
.IX Item "--verbose"
Print output for otherwise silent and potentially long-running commands.
Only for specific subcommands, as noted in their description.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
\&\fBdpt-salsa\fR uses the following environment variables, set either directly
or via \fI~/.dpt.conf\fR / \fI~/.config/dpt.conf\fR:
.IP DPT_SALSA_PRIVATE_TOKEN 4
.IX Item "DPT_SALSA_PRIVATE_TOKEN"
required, no default, obviously
.Sp
These tokens are created at
<https://salsa.debian.org/\-/profile/personal_access_tokens>.
Note that the token needs \fBapi\fR and \fBread_user\fR scope permissions.
.IP DPT_SALSA_API_URL 4
.IX Item "DPT_SALSA_API_URL"
optional, default: https://salsa.debian.org/api/v4
.IP DPT_SALSA_PERL_TEAM_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_PATH"
optional, default: perl-team
.IP DPT_SALSA_PERL_TEAM_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_ID"
optional, default: 2663
.IP DPT_SALSA_PERL_TEAM_INTERPRETER_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_INTERPRETER_PATH"
optional, default: perl\-team/interpreter
.IP DPT_SALSA_PERL_TEAM_INTERPRETER_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_INTERPRETER_ID"
optional, default: 2664
.IP DPT_SALSA_PERL_TEAM_MODULES_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_PATH"
optional, default: perl\-team/modules
.IP DPT_SALSA_PERL_TEAM_MODULES_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_ID"
optional, default: 2665
.IP DPT_SALSA_PERL_TEAM_MODULES_PACKAGES_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_PACKAGES_PATH"
optional, default: perl\-team/modules/packages
.IP DPT_SALSA_PERL_TEAM_MODULES_PACKAGES_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_PACKAGES_ID"
optional, default: 2666
.IP DPT_SALSA_PERL_TEAM_MODULES_ATTIC_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_ATTIC_PATH"
optional, default: perl\-team/modules/attic
.IP DPT_SALSA_PERL_TEAM_MODULES_ATTIC_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_ATTIC_ID"
optional, default: 2667
.IP DPT_SALSA_PERL_TEAM_MODULES_META_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_META_PATH"
optional, default: perl\-team/modules/meta
.IP DPT_SALSA_PERL_TEAM_MODULES_META_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_MODULES_META_ID"
optional, default: 13881
.IP DPT_SALSA_PERL_TEAM_PAGES_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_PAGES_PATH"
optional, default: perl\-team/perl\-team.pages.debian.net
.IP DPT_SALSA_PERL_TEAM_PAGES_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_PAGES_ID"
optional, default: 11266
.IP DPT_SALSA_PERL_TEAM_SCRIPTS_PATH 4
.IX Item "DPT_SALSA_PERL_TEAM_SCRIPTS_PATH"
optional, default: perl\-team/scripts
.IP DPT_SALSA_PERL_TEAM_SCRIPTS_ID 4
.IX Item "DPT_SALSA_PERL_TEAM_SCRIPTS_ID"
optional, default: 13429
.IP DPT_PACKAGES 4
.IX Item "DPT_PACKAGES"
only used by the \fBmrconfig\fR subcommand, no default;
most probably already set for use with other \fBdpt\fR commands.
.PP
Cf. \fBdpt\-config\fR\|(5).
.PP
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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<https://salsa.debian.org/perl\-team>
.PP
GitLab::API::v4
.PP
<https://docs.gitlab.com/ce/api/>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2018\-2022, gregor herrmann <gregoa@debian.org>
.PP
Released under the same terms as Perl itself, i.e. Artistic or GPL\-1+.