JirAgileR (version 0.0.2.1)

save_jira_credentials: Saves domain and the domain's credentials in the environment

Description

Saves the domain and/or username and password in the users' environment. It has the advantage that it is not necessary to explicitly publish the credentials in the users code. Just do it one time and you are set. To update any of the parameters just save again and it will overwrite the older credential.

Usage

save_jira_credentials(
  domain = NULL,
  username = NULL,
  password = NULL,
  verbose = FALSE
)

Arguments

domain

The users' JIRA server domain to retrieve information from. An example would be https://bugreports.qt.io. It will be saved in the environment as JIRAGILER_DOMAIN.

username

The users' username to authenticate to the domain. It will be saved in the environment as JIRAGILER_USERNAME.

password

The users' password to authenticate to the domain. It will be saved in the environment as JIRAGILER_PASSWORD. If verbose is set to TRUE, it will message asterisks.

verbose

Optional parameter to inform the user when the users' credentials have been saved.

Value

Saves the credentials in the users environment - it does not return any object.

Examples

# NOT RUN {
save_jira_credentials(domain="https://bugreports.qt.io",
                      username='__INSERT_YOUR_USERNAME_HERE__',
                      password='__INSERT_YOUR_PASSWORD_HERE__')
# }