git-bug-bridge-configure.1

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