git-bug-bridge-configure.1

  1.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" 
  2.nh
  3.ad l
  4
  5
  6.SH NAME
  7.PP
  8git\-bug\-bridge\-configure \- Configure a new bridge.
  9
 10
 11.SH SYNOPSIS
 12.PP
 13\fBgit\-bug bridge configure [flags]\fP
 14
 15
 16.SH DESCRIPTION
 17.PP
 18.RS
 19
 20.nf
 21Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge.
 22Repository configuration can be made by passing either the \-\-url flag or the \-\-project and \-\-owner flags. If the three flags are provided git\-bug will use \-\-project and \-\-owner flags.
 23Token configuration can be directly passed with the \-\-token flag or in the terminal prompt. If you don't already have one you can use the interactive procedure to generate one.
 24
 25.fi
 26.RE
 27
 28
 29.SH OPTIONS
 30.PP
 31\fB\-n\fP, \fB\-\-name\fP=""
 32    A distinctive name to identify the bridge
 33
 34.PP
 35\fB\-t\fP, \fB\-\-target\fP=""
 36    The target of the bridge. Valid values are [github,gitlab,launchpad\-preview]
 37
 38.PP
 39\fB\-u\fP, \fB\-\-url\fP=""
 40    The URL of the target repository
 41
 42.PP
 43\fB\-b\fP, \fB\-\-base\-url\fP=""
 44    The base URL of your issue tracker service
 45
 46.PP
 47\fB\-o\fP, \fB\-\-owner\fP=""
 48    The owner of the target repository
 49
 50.PP
 51\fB\-c\fP, \fB\-\-credential\fP=""
 52    The identifier or prefix of an already known credential for the API (see "git\-bug bridge auth")
 53
 54.PP
 55\fB\-\-token\fP=""
 56    A raw authentication token for the API
 57
 58.PP
 59\fB\-\-token\-stdin\fP[=false]
 60    Will read the token from stdin and ignore \-\-token
 61
 62.PP
 63\fB\-p\fP, \fB\-\-project\fP=""
 64    The name of the target repository
 65
 66.PP
 67\fB\-h\fP, \fB\-\-help\fP[=false]
 68    help for configure
 69
 70
 71.SH EXAMPLE
 72.PP
 73.RS
 74
 75.nf
 76# Interactive example
 77[1]: github
 78[2]: launchpad\-preview
 79target: 1
 80name [default]: default
 81
 82Detected projects:
 83[1]: github.com/a\-hilaly/git\-bug
 84[2]: github.com/MichaelMure/git\-bug
 85
 86[0]: Another project
 87
 88Select option: 1
 89
 90[1]: user provided token
 91[2]: interactive token creation
 92Select option: 1
 93
 94You can generate a new token by visiting https://github.com/settings/tokens.
 95Choose 'Generate new token' and set the necessary access scope for your repository.
 96
 97The access scope depend on the type of repository.
 98Public:
 99	\- 'public\_repo': to be able to read public repositories
100Private:
101	\- 'repo'       : to be able to read private repositories
102
103Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700
104Successfully configured bridge: default
105
106# For GitHub
107git bug bridge configure \\
108    \-\-name=default \\
109    \-\-target=github \\
110    \-\-owner=$(OWNER) \\
111    \-\-project=$(PROJECT) \\
112    \-\-token=$(TOKEN)
113
114# For Launchpad
115git bug bridge configure \\
116    \-\-name=default \\
117    \-\-target=launchpad\-preview \\
118	\-\-url=https://bugs.launchpad.net/ubuntu/
119
120# For Gitlab
121git bug bridge configure \\
122    \-\-name=default \\
123    \-\-target=github \\
124    \-\-url=https://github.com/michaelmure/git\-bug \\
125    \-\-token=$(TOKEN)
126
127.fi
128.RE
129
130
131.SH SEE ALSO
132.PP
133\fBgit\-bug\-bridge(1)\fP