aboutsummaryrefslogtreecommitdiffstats
path: root/doc/md/git-bug_bridge_configure.md
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2020-02-15 02:55:19 +0100
committerMichael Muré <batolettre@gmail.com>2020-02-15 02:55:19 +0100
commitfe3d5c95e4be5874066402b5463ada34894c7f01 (patch)
tree29f04fae0dc3d5d4883d4989012c26109ba754dc /doc/md/git-bug_bridge_configure.md
parent2df72942f2b057956c7873f908b64880ab647331 (diff)
downloadgit-bug-fe3d5c95e4be5874066402b5463ada34894c7f01.tar.gz
bridges: massive refactor
- automatic flag validation and warning - generalized prompt - cleanups
Diffstat (limited to 'doc/md/git-bug_bridge_configure.md')
-rw-r--r--doc/md/git-bug_bridge_configure.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/md/git-bug_bridge_configure.md b/doc/md/git-bug_bridge_configure.md
index c0f89cf3..9695684b 100644
--- a/doc/md/git-bug_bridge_configure.md
+++ b/doc/md/git-bug_bridge_configure.md
@@ -5,8 +5,6 @@ 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.
- Repository configuration can be made by passing either the --url flag or the --project and --owner flags. If the three flags are provided git-bug will use --project and --owner flags.
- Token configuration can be directly passed with the --token flag or in the terminal prompt. If you don't already have one you can use the interactive procedure to generate one.
```
git-bug bridge configure [flags]
@@ -17,7 +15,10 @@ git-bug bridge configure [flags]
```
# Interactive example
[1]: github
-[2]: launchpad-preview
+[2]: gitlab
+[3]: jira
+[4]: launchpad-preview
+
target: 1
name [default]: default
@@ -72,13 +73,14 @@ git bug bridge configure \
```
-n, --name string A distinctive name to identify the bridge
-t, --target string The target of the bridge. Valid values are [github,gitlab,launchpad-preview]
- -u, --url string The URL of the target repository
- -b, --base-url string The base URL of your issue tracker service
- -o, --owner string The owner of the target repository
- -c, --credential string The identifier or prefix of an already known credential for the API (see "git-bug bridge auth")
- --token string A raw authentication token for the API
+ -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
- -p, --project string The name of the target repository
+ -o, --owner string The owner of the remote repository
+ -p, --project string The name of the remote repository
-h, --help help for configure
```