diff options
| author | Amine Hilaly <hilalyamine@gmail.com> | 2019-05-29 20:50:30 +0200 |
|---|---|---|
| committer | Amine Hilaly <hilalyamine@gmail.com> | 2019-05-29 22:58:01 +0200 |
| commit | d064a7127ec612a804e08143c7098bbc60332e83 (patch) | |
| tree | 222d92b6e199f5050799782e9a41e229ac625833 /doc/md/git-bug_bridge_configure.md | |
| parent | 45d47a0966410840dfe4e90584ba0147eb334634 (diff) | |
| download | git-bug-d064a7127ec612a804e08143c7098bbc60332e83.tar.gz | |
Update man pages and bash_completion
Diffstat (limited to 'doc/md/git-bug_bridge_configure.md')
| -rw-r--r-- | doc/md/git-bug_bridge_configure.md | 60 |
1 files changed, 58 insertions, 2 deletions
diff --git a/doc/md/git-bug_bridge_configure.md b/doc/md/git-bug_bridge_configure.md index 63fbbbca..db603b48 100644 --- a/doc/md/git-bug_bridge_configure.md +++ b/doc/md/git-bug_bridge_configure.md @@ -4,16 +4,72 @@ Configure a new bridge. ### Synopsis -Configure a new bridge. + 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] ``` +### Examples + +``` +# Interactive example +[1]: github +[2]: 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 + +[0]: user provided token +[1]: interactive token creation +Select option: 0 + +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: +Successfully configured bridge: default + +# For Github +git bug bridge configure \ + --name=default \ + --target=github \ + --owner=$(OWNER) \ + --project=$(PROJECT) \ + --token=$(TOKEN) + +# For Launchpad +git bug bridge configure \ + --name=default \ + --target=launchpad-preview \ + --url=https://bugs.launchpad.net/ubuntu/ +``` + ### Options ``` - -h, --help help for configure + -n, --name string A distinctive name to identify the bridge + -t, --target string The target of the bridge. Valid values are [github,launchpad-preview] + -u, --url string The URL of the target repository + -o, --owner string The owner of the target repository + -T, --token string The authentication token for the API + -p, --project string The name of the target repository + -h, --help help for configure ``` ### SEE ALSO |