docs: update implementation table

docs: add bridge usage examples
This commit is contained in:
Amine Hilaly 2019-08-24 13:55:49 +02:00
parent 2585726ac3
commit 03b6afa2f3
No known key found for this signature in database
GPG Key ID: 3F4C54B792F211C1
2 changed files with 42 additions and 9 deletions

View File

@ -135,13 +135,39 @@ 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
configure a new github bridge
```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 mybridge
```
export modifications
```bash
git bug bridge push mybridge
```
deleting a bridge
```bash
git bug bridge rm mybridge
```
## Internals

View File

@ -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=mybridge \
--target=github \
--url=https://github.com/michaelmure/git-bug \
--token=$(TOKEN)`,
PreRunE: loadRepo,
RunE: runBridgeConfigure,
}