Skip to content

Jira Add Comment module

Add a comment to the Jira issue.

main(credential_file, comment, comment_file, issue)

Add a comment to the Jira issue.

Parameters:

Name Type Description Default
credential_file str

credential file containing username and password - default is '~/.jira/credentials.txt'

 required
comment str

text to be added as a comment to the specified issue

 required
comment_file str

file containing the text to be added as a comment to the specified issue

 required
issue str

the issue id

 required
Source code in jira_python_utils/jira_add_comment.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@click.command()
@click.option('--credential_file', help=f"credential file containing username and password - default is '{DEFAULT_CREDENTIAL_FILE}'")
@click.option('--comment', help='text to be added as a comment to the specified issue')
@click.option('--comment_file', help='file containing the text to be added as a comment to the specified issue')
@click.argument('issue')
def main(credential_file: str, comment: str, comment_file: str, issue: str):
    """Add a comment to the Jira issue.

    Args:
        credential_file (str): credential file containing username and password - default is '~/.jira/credentials.txt'
        comment (str): text to be added as a comment to the specified issue
        comment_file (str): file containing the text to be added as a comment to the specified issue
        issue (str): the issue id
    """

    error_ctr = 0

    if issue is None:
        error_console.print("issue was not specified")
        error_ctr += 1

    if comment is None and comment_file is None:
        error_console.print("--comment and --comment_file were not specified")
        error_ctr += 1

    if comment == '':
        error_console.print("You must provide some text for the comment")
        error_ctr += 1

    if error_ctr > 0:
        click.echo(click.get_current_context().get_help())
        sys.exit(1)

    url = get_jira_url(DEFAULT_URL_FILE)

    if credential_file is None:
        credential_file = DEFAULT_CREDENTIAL_FILE

    check_infile_status(credential_file)

    if comment_file is not None:
        check_infile_status(comment_file)
        with open(comment_file, 'r') as cf:
            comment = cf.read()

    auth_jira = get_auth(credential_file, url)

    if auth_jira is None:
        error_console.print("Could not instantiate JIRA for url '{}'".format(url))
        sys.exit(1)

    console.print(f"Will attempt to add comment '{comment}' to issue '{issue}'")

    auth_jira.add_comment(issue, comment)

    console.print(f"Added comment '{comment}' to issue '{issue}'")