git-bug-bridge-configure.1

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