[YETUS-294] release-doc-maker fails if some custom fields aren't defined on JIRA

• Type: Bug
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: Release Doc Maker
• Assignee: Unassigned
• Reporter: Kengo Seki
• Created: 27/Jan/16 09:00
• Updated: 10/Sep/23 18:34

Description

YETUS-282 enables release-doc-maker to support JIRAs other than ASF's, but if these JIRAs don't have custom fields such as "Hadoop Flags", "Flags" and "Release Note", it will fail.

Examples using a local JIRA server:

[sekikn@mobile yetus]$ release-doc-maker/releasedocmaker.py --project test --version 0.1.0 --baseurl http://localhost:8080
Traceback (most recent call last):
  File "release-doc-maker/releasedocmaker.py", line 698, in <module>
    main()
  File "release-doc-maker/releasedocmaker.py", line 572, in main
    if jira.get_incompatible_change():
  File "release-doc-maker/releasedocmaker.py", line 284, in get_incompatible_change
    field = self.parent.field_id_map['Hadoop Flags']
KeyError: 'Hadoop Flags'

(after the 'Hadoop Flags' field is defined)
[sekikn@mobile yetus]$ release-doc-maker/releasedocmaker.py --project test --version 0.1.0 --baseurl http://localhost:8080
Traceback (most recent call last):
  File "release-doc-maker/releasedocmaker.py", line 698, in <module>
    main()
  File "release-doc-maker/releasedocmaker.py", line 574, in main
    elif jira.get_important():
  File "release-doc-maker/releasedocmaker.py", line 298, in get_important
    field = self.parent.field_id_map['Flags']
KeyError: 'Flags'

(after the 'Flags' field is defined)
[sekikn@mobile yetus]$ release-doc-maker/releasedocmaker.py --project test --version 0.1.0 --baseurl http://localhost:8080
Traceback (most recent call last):
  File "release-doc-maker/releasedocmaker.py", line 698, in <module>
    main()
  File "release-doc-maker/releasedocmaker.py", line 628, in main
    if len(jira.get_release_note()) > 0:
  File "release-doc-maker/releasedocmaker.py", line 216, in get_release_note
    field = self.parent.field_id_map['Release Note']
KeyError: 'Release Note'

Maybe we can assume that the "Release Note" field is defined because it's vital for release-doc-making, but it'd be better that dependencies on other two custom fields are removed.