diff options
| author | Michael Muré <batolettre@gmail.com> | 2019-08-24 14:19:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-24 14:19:59 +0200 |
| commit | 8870fa9d9202a311cf67c2b29a06c4ccfc664399 (patch) | |
| tree | c0ca994574c5a71ef355c39d67bcf8dcf74b1407 | |
| parent | 2585726ac39c95b5ad81bc5bece003b79c0b5faa (diff) | |
| parent | 35c6cb6e36a0db48bfed2cd7ba5954537f9dfae6 (diff) | |
| download | git-bug-8870fa9d9202a311cf67c2b29a06c4ccfc664399.tar.gz | |
Merge pull request #201 from MichaelMure/bridge-docs
bridge: add documentation
| -rw-r--r-- | README.md | 50 | ||||
| -rw-r--r-- | commands/bridge_configure.go | 11 |
2 files changed, 52 insertions, 9 deletions
@@ -135,13 +135,49 @@ The web UI interact with the backend through a GraphQL API. The schema is availa | | Github | Gitlab | Launchpad | | --- | --- | --- | --- | -| **bug** | :heavy_check_mark: | :x: | :x: | -| comments | :heavy_check_mark: | :x: | :x: | -| comment editions | :heavy_check_mark: | :x: | :x: | -| labels | :heavy_check_mark: | :x: | :x: | -| status | :heavy_check_mark: | :x: | :x: | -| title edition | :heavy_check_mark: | :x: | :x: | -| **automated test suite** | :heavy_check_mark: | :x: | :x: | +| **bug** | :heavy_check_mark: | :heavy_check_mark: | :x: | +| comments | :heavy_check_mark: | :heavy_check_mark: | :x: | +| comment editions | :heavy_check_mark: | :heavy_check_mark: | :x: | +| labels | :heavy_check_mark: | :heavy_check_mark: | :x: | +| status | :heavy_check_mark: | :heavy_check_mark: | :x: | +| title edition | :heavy_check_mark: | :heavy_check_mark: | :x: | +| **automated test suite** | :heavy_check_mark: | :heavy_check_mark: | :x: | + +#### Bridge usage + +Interactively configure a new github bridge: + +```bash +git bug bridge configure +``` + +Or manually: + +```bash +git bug bridge configure \ + --name=mybridge \ + --target=github \ + --url=https://github.com/michaelmure/git-bug \ + --token=$TOKEN +``` + +Import bugs: + +```bash +git bug bridge pull [<name>] +``` + +Export modifications: + +```bash +git bug bridge push [<name>] +``` + +Deleting a bridge: + +```bash +git bug bridge rm [<name>] +``` ## Internals diff --git a/commands/bridge_configure.go b/commands/bridge_configure.go index e3576ead..6bebc262 100644 --- a/commands/bridge_configure.go +++ b/commands/bridge_configure.go @@ -160,7 +160,7 @@ Private: Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700 Successfully configured bridge: default -# For Github +# For GitHub git bug bridge configure \ --name=default \ --target=github \ @@ -172,7 +172,14 @@ git bug bridge configure \ git bug bridge configure \ --name=default \ --target=launchpad-preview \ - --url=https://bugs.launchpad.net/ubuntu/`, + --url=https://bugs.launchpad.net/ubuntu/ + +# For Gitlab +git bug bridge configure \ + --name=default \ + --target=github \ + --url=https://github.com/michaelmure/git-bug \ + --token=$(TOKEN)`, PreRunE: loadRepo, RunE: runBridgeConfigure, } |