.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "API::GitForge::Role::GitForge 3pm"
.TH API::GitForge::Role::GitForge 3pm "2021-02-09" "perl v5.32.1" "User Contributed Perl Documentation"
.\" 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"
API::GitForge::Role::GitForge \- role implementing generic git forge operations
.SH "VERSION"
.IX Header "VERSION"
version 0.006
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Operations which one might wish to perform against any git forge.  See
API::GitForge.
.PP
In this documentation, \f(CW\*(C`example.com\*(C'\fR should be replaced with the
domain at which your git forge is hosted, e.g. \f(CW\*(C`salsa.debian.org\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new(domain => $domain, access_token => $token)"
.el .SS "new(domain => \f(CW$domain\fP, access_token => \f(CW$token\fP)"
.IX Subsection "new(domain => $domain, access_token => $token)"
Instantiate an object representing the GitForge at \f(CW$domain\fR.  The
\&\f(CW\*(C`access_key\*(C'\fR argument is optional; if present, it should be an \s-1API\s0
key for the forge.
.SS "ensure_repo($repo)"
.IX Subsection "ensure_repo($repo)"
Create a new repo at \f(CW\*(C`https://example.com/$repo\*(C'\fR.
.SS "clean_repo($repo)"
.IX Subsection "clean_repo($repo)"
Create a new repo at \f(CW\*(C`https://example.com/$repo\*(C'\fR and turn off
optional forge features.
.SS "ensure_fork($upstream)"
.IX Subsection "ensure_fork($upstream)"
Ensure that the current user has a fork of the repo at
\&\f(CW\*(C`https://example.com/$upstream\*(C'\fR, and return \s-1URI\s0 to that fork suitable
for adding as a git remote.
.SS "clean_fork($upstream)"
.IX Subsection "clean_fork($upstream)"
Ensure that the current user has a fork of the repo at
\&\f(CW\*(C`https://example.com/$upstream\*(C'\fR, config that fork to make it obvious
it's only there for submitting change proposals, and return \s-1URI\s0 to
fork suitable for adding as a git remote.
.SS "nuke_fork($upstream)"
.IX Subsection "nuke_fork($upstream)"
Delete the user's fork of the repo at
\&\f(CW\*(C`https://example.com/$upstream\*(C'\fR.
.SS "clean_config_repo($repo)"
.IX Subsection "clean_config_repo($repo)"
Turn off optional forge features for repo at
\&\f(CW\*(C`https://example.com/$repo\*(C'\fR.
.SS "clean_config_fork($upstream)"
.IX Subsection "clean_config_fork($upstream)"
Configure user's fork of repo at \f(CW\*(C`https://example.com/$upstream\*(C'\fR to
make it obvious that it's only there for submitting change proposals.
.SH "STATUS"
.IX Header "STATUS"
Unstable.  Interface may change.
.SH "AUTHOR"
.IX Header "AUTHOR"
Sean Whitton <spwhitton@spwhitton.name>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2017, 2020 by Sean Whitton <spwhitton@spwhitton.name>.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve