aboutsummaryrefslogtreecommitdiffstats
path: root/doc/md/git-bug_bridge_new.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/md/git-bug_bridge_new.md')
-rw-r--r--doc/md/git-bug_bridge_new.md91
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/md/git-bug_bridge_new.md b/doc/md/git-bug_bridge_new.md
new file mode 100644
index 00000000..81bffd49
--- /dev/null
+++ b/doc/md/git-bug_bridge_new.md
@@ -0,0 +1,91 @@
+## git-bug bridge new
+
+Configure a new bridge
+
+### Synopsis
+
+ 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.
+
+```
+git-bug bridge new [flags]
+```
+
+### Examples
+
+```
+# Interactive example
+[1]: github
+[2]: gitlab
+[3]: jira
+[4]: launchpad-preview
+
+target: 1
+name [default]: default
+
+Detected projects:
+[1]: github.com/a-hilaly/git-bug
+[2]: github.com/MichaelMure/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=$(OWNER) \
+ --project=$(PROJECT) \
+ --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=github \
+ --url=https://github.com/michaelmure/git-bug \
+ --token=$(TOKEN)
+```
+
+### Options
+
+```
+ -n, --name string A distinctive name to identify the bridge
+ -t, --target string The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview]
+ -u, --url string The URL of the remote repository
+ -b, --base-url string The base URL of your remote issue tracker
+ -l, --login string The login on your remote issue tracker
+ -c, --credential string The identifier or prefix of an already known credential for your remote issue tracker (see "git-bug bridge auth")
+ --token string A raw authentication token for the remote issue tracker
+ --token-stdin Will read the token from stdin and ignore --token
+ -o, --owner string The owner of the remote repository
+ -p, --project string The name of the remote repository
+ --non-interactive Do not ask for user input
+ -h, --help help for new
+```
+
+### SEE ALSO
+
+* [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers
+