.\" -*- 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-invite-github 1"
.TH dpt-invite-github 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\-invite\-github \- Invite someone to a GitHub organization
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    dpt invite\-github [option...] {github\-username}
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdpt invite-github\fR can be used for inviting people to become members
of a GitHub organization. You can set the organization name through
\&\f(CW\*(C`DPT_GITHUB_ORGNAME\*(C'\fR environment variable (defaults to \fIpkg-perl-tools\fR).
.PP
This script needs the \f(CW\*(C`DPT_GITHUB_OAUTH\*(C'\fR environment variable,
which can be set in \fI~/.dpt.conf\fR or \fI~/.config/dpt.conf\fR.
Cf. \fBdpt\-github\-oauth\fR\|(1) and \fBdpt\-config\fR\|(5).
.PP
You need to have write access to the \f(CW\*(C`admin:org\*(C'\fR scope to be able to
manage organization memberships. Please, make sure the token you use
has that scope in <https://github.com/settings/tokens>.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-\-role\fR \fIname\fR" 4
.IX Item "--role name"
This option sets the role for the user. Valid roles are \fIadmin\fR or \fImember\fR,
which is the default.
.IP \fB\-\-force\fR 4
.IX Item "--force"
Use this option if the GitHub user is already a member of the organization
and you want to change their role anyway.
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
.IP "Copyright 2016 Alex Muntada." 4
.IX Item "Copyright 2016 Alex Muntada."
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.