aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jira_bridge.md
diff options
context:
space:
mode:
authorJosh Bialkowski <josh.bialkowski@gmail.com>2019-12-13 13:17:26 -0800
committerJosh Bialkowski <josh.bialkowski@gmail.com>2019-12-18 07:42:16 -0800
commit4e64c834e2cd672f3daff59fe8117873688dfebc (patch)
tree694269594f13f4f9d545e0bd8a2c8a08df1e5a9e /doc/jira_bridge.md
parent98bd372e604285cf79ffcf04d0fdf423200cab8f (diff)
downloadgit-bug-4e64c834e2cd672f3daff59fe8117873688dfebc.tar.gz
codereview #5: reverse-map and ImportWarning
* Fix git config reader can't read values with spaces * Add bug-id-revmap config option for the reverse map, and use this in the importer * Add NewImportWarning for things that aren't exactly errors. Use this for unhandled changelog events. * Add NewExportWarning for things that aren't exactly errors. Use this for un-exportable status changes. * Strip newlines from titles on import
Diffstat (limited to 'doc/jira_bridge.md')
-rw-r--r--doc/jira_bridge.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/jira_bridge.md b/doc/jira_bridge.md
index 3352d1b5..df56bb2d 100644
--- a/doc/jira_bridge.md
+++ b/doc/jira_bridge.md
@@ -208,11 +208,24 @@ create-issue-gitbug-id = "customfield_5678"
You can specify the mapping between `git-bug` status and JIRA status id's using
the following:
```
-bug-id-map = {"open": "1", "closed": "6"}
+bug-id-map = {\"open\": \"1\", \"closed\": \"6\"}
```
+The format of the map is `<git-bug-status-name>: <jira-status-id>`. In general
+your jira instance will have more statuses than `git-bug` will and you may map
+more than one jira-status to a git-bug status. You can do this with
+`bug-id-revmap`:
+```
+bug-id-revmap = {\"10109\": \"open\", \"10006\": \"open\", \"10814\": \"open\"}
+```
+
+The reverse map `bug-id-revmap` will automatically include the inverse of the
+forward map `bug-id-map`.
+
Note that in JIRA each different `issuetype` can have a different set of
statuses. The bridge doesn't currently support more than one mapping, however.
+Also, note that the format of the map is JSON and the git config file syntax
+requires doublequotes to be escaped (as in the examples above).
### Full example