Skip to content

Commit

Permalink
docs: clarify usage of custom Jira fields
Browse files Browse the repository at this point in the history
  • Loading branch information
EquineOntology authored and ryneeverett committed Nov 15, 2024
1 parent 7e66aff commit 8997a5c
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion bugwarrior/docs/services/jira.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,11 +194,23 @@ Provided UDA Fields
Support for Extra UDA Fields
+++++++++++++++++++++++++++++

To export additional UDA fields, set ``extra_fields`` to comma-separated entries of the form ``uda_tag:field_key[.subkey]``. You can also chain subkeys to extract deeply embedded keys, e.g.:
Exporting additional UDA fields is a two-step process.

First, set ``extra_fields`` to comma-separated entries of the form ``uda_tag:field_key[.subkey]``. You can also chain subkeys to extract deeply embedded keys, e.g.:

.. config::
:fragment: jira

jira.extra_fields = jiraextrafield1:customfield_10000, jiraextrafield2:customfield_10001.attributes.description

The correct key (and subkeys) can be found by inspecting the `fields` attribute of a standard Jira issue response.

Second, `add the new UDA(s) to taskwarrior`_. Assuming `jiraextrafield1` is a string, you would run:

::

$ task config uda.jiraextrafield1.type string
$ task config uda.jiraextrafield1.label My Extra Field

.. _add the new UDA(s) to taskwarrior: https://taskwarrior.org/docs/udas/#example-estimate

0 comments on commit 8997a5c

Please sign in to comment.