Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify usage of custom Jira fields #1079

Merged
merged 1 commit into from
Nov 15, 2024
Merged

docs: clarify usage of custom Jira fields #1079

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion bugwarrior/docs/services/jira.rst
View file
Open in desktop
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

Loading