add_comment: Comment on an existing issue

In awalker89/Rjira: Jira API wrapper for R

Description

Comment on an existing issue

Usage

add_comment(issue, comment, jira_url = getOption("jira_url"),
  jira_user = getOption("jira_user"),
  jira_password = getOption("jira_password"),
  verbose = getOption("jira_verbose"))

Arguments

issue	An existing issue id or key.
comment	Character vector, list or data.frame. See examples.
jira_url	base url to JIRA. Defaults to 'jira/'
jira_user	username for authentication
jira_password	password for authentication
verbose	FALSE

Value

POST results

Examples

## Not run: 

## set options
options("jira_user" = "my_user_name")
options("jira_password" = "xxxx")
options("jira_url" = "jira/")
options("jira_project" = "BAS")

## write comment to issue
add_comment(issue = "BAS-1", comment = "A comment")

## comment with formatting
my_comment <- "
 Bullet points example
 * point 1
 ** point 1.1
 * point 2
"
add_comment(issue = "BAS-1", comment = my_comment) ## test formatting


## write a data.frame as a table
my_results_comment <- list("The results of this analysis:", head(iris, 4))
add_comment(issue = "BAS-1", comment = my_results_comment) ## formatting works


## End(Not run)

awalker89/Rjira documentation built on May 11, 2019, 4:09 p.m.