summaryrefslogtreecommitdiffstatshomepage
path: root/doc/man/git-bug-bridge-new.1
blob: f9b11853d07939cf2df5f04c839d7db30d34083e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
.nh
.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" ""

.SH NAME
git-bug-bridge-new - Configure a new bridge


.SH SYNOPSIS
\fBgit-bug bridge new [flags]\fP


.SH DESCRIPTION
Configure 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.


.SH OPTIONS
\fB-n\fP, \fB--name\fP=""
	A distinctive name to identify the bridge

.PP
\fB-t\fP, \fB--target\fP=""
	The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview]

.PP
\fB-u\fP, \fB--url\fP=""
	The URL of the remote repository

.PP
\fB-b\fP, \fB--base-url\fP=""
	The base URL of your remote issue tracker

.PP
\fB-l\fP, \fB--login\fP=""
	The login on your remote issue tracker

.PP
\fB-c\fP, \fB--credential\fP=""
	The identifier or prefix of an already known credential for your remote issue tracker (see "git-bug bridge auth")

.PP
\fB--token\fP=""
	A raw authentication token for the remote issue tracker

.PP
\fB--token-stdin\fP[=false]
	Will read the token from stdin and ignore --token

.PP
\fB-o\fP, \fB--owner\fP=""
	The owner of the remote repository

.PP
\fB-p\fP, \fB--project\fP=""
	The name of the remote repository

.PP
\fB--non-interactive\fP[=false]
	Do not ask for user input

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for new


.SH EXAMPLE
.EX
# Interactive example
[1]: github
[2]: gitlab
[3]: jira
[4]: launchpad-preview

target: 1
name [default]: default

Detected projects:
[1]: github.com/git-bug/git-bug

[0]: Another project

Select option: 1

[1]: user provided token
[2]: interactive token creation
Select option: 1

You can generate a new token by visiting https://github.com/settings/tokens.
Choose 'Generate new token' and set the necessary access scope for your repository.

The access scope depend on the type of repository.
Public:
	- 'public_repo': to be able to read public repositories
Private:
	- 'repo'       : to be able to read private repositories

Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700
Successfully configured bridge: default

# For GitHub
git bug bridge new \\
    --name=default \\
    --target=github \\
    --owner=example-owner
    --project=example-repo \\
    --token=$TOKEN

# For Launchpad
git bug bridge new \\
    --name=default \\
    --target=launchpad-preview \\
    --url=https://bugs.launchpad.net/ubuntu/

# For Gitlab
git bug bridge new \\
    --name=default \\
    --target=gitlab \\
    --url=https://github.com/example-org/example-repo \\
    --token=$TOKEN
.EE


.SH SEE ALSO
\fBgit-bug-bridge(1)\fP