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