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 [gitea-preview,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--non-interactive\fP[=false]
 68	Do not ask for user input
 69
 70.PP
 71\fB-h\fP, \fB--help\fP[=false]
 72	help for configure
 73
 74
 75.SH EXAMPLE
 76.PP
 77.RS
 78
 79.nf
 80# Interactive example
 81[1]: github
 82[2]: gitlab
 83[3]: jira
 84[4]: launchpad-preview
 85
 86target: 1
 87name [default]: default
 88
 89Detected projects:
 90[1]: github.com/a-hilaly/git-bug
 91[2]: github.com/MichaelMure/git-bug
 92
 93[0]: Another project
 94
 95Select option: 1
 96
 97[1]: user provided token
 98[2]: interactive token creation
 99Select option: 1
100
101You can generate a new token by visiting https://github.com/settings/tokens.
102Choose 'Generate new token' and set the necessary access scope for your repository.
103
104The access scope depend on the type of repository.
105Public:
106	- 'public_repo': to be able to read public repositories
107Private:
108	- 'repo'       : to be able to read private repositories
109
110Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700
111Successfully configured bridge: default
112
113# For GitHub
114git bug bridge configure \\
115    --name=default \\
116    --target=github \\
117    --owner=$(OWNER) \\
118    --project=$(PROJECT) \\
119    --token=$(TOKEN)
120
121# For Launchpad
122git bug bridge configure \\
123    --name=default \\
124    --target=launchpad-preview \\
125	--url=https://bugs.launchpad.net/ubuntu/
126
127# For Gitlab
128git bug bridge configure \\
129    --name=default \\
130    --target=github \\
131    --url=https://github.com/michaelmure/git-bug \\
132    --token=$(TOKEN)
133
134.fi
135.RE
136
137
138.SH SEE ALSO
139.PP
140\fBgit-bug-bridge(1)\fP