Config file

Location

If you haven’t used Jipdate before, then the script will create a .jipdate.yml config automatically. It will store it at one of the following locations.

$HOME/.config/jipdate/.jipdate.yml
$HOME/.jipdate.yml
$HOME/.../<jipdate-script-dir>/.jipdate.yml

You can move it to any of the three folders if you have any preference.

Example config

Jipdate config files are written in YAML format and a typical config file looks like this:

# Config file for jipdate
# For use in future (backwards compatibility)
version: 1

# Jira server information
#server:
#  url: https://linaro.atlassian.net
#  token: abcdefghijkl

#test_server:
#  url: https://<name_of_test_instance>.atlassian.net
#  token: abcdefghijkl

# Extra comments added to each Jira issue (multiline is OK)
comments:
    - "# No updates since last week."

# Header of the file (multiline is OK). It will be followed by
header:
    - |
      Hi,

      This is the status update from me for the
      last week.

      Cheers!

# Set this to 'True' if you want to get the issue header merged with the issue
# number.
use_combined_issue_header: False

# Default separator in the issue header, change to the separator of your own
# preference.
separator: ' | '
text-editor: True
username: john.doe@linaro.org

You will need to re-run the script after making a changes to the config file.

Config options

comments

This can be used to put a default line(s) showing up at each Jira ticket when doing a query. I.e., this is what is shown at line 5 and 11 in the example below.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
[SWG-355]
# Header: Centralize and update OP-TEE documentation
# Type: Epic
# Status: In Progress
# No updates since last week.

[SWG-338]
# Header: OP-TEE issues at GitHub
# Type: Epic
# Status: To Do
# No updates since last week.

use_combined_issue_header

This will decide if [XYZ-123] and the name of the ticket name should be merged into a single line or not. I.e.

use_combined_issue_header: False gives:

1
2
3
4
5
6
[SWG-355]
# Header: Centralize and update OP-TEE documentation
# Type: Epic
# Status: In Progress
# No updates since last week.
...

use_combined_issue_header: True gives:

1
2
3
4
[SWG-355 | Centralize and update OP-TEE documentation]
# Type: Epic
# Status: In Progress
# No updates since last week.

separator

This gives the Jipdate user the ability to use another separate than the default |. This is only useful if use_combined_issue_header: True. For example if you change it to:

separator: ': '

Then Jipdate will output Jira sections like this:

[SWG-355: Centralize and update OP-TEE documentation]
# Type: Epic
# Status: In Progress
# No updates since last week.

text-editor

This is a simple True and False deciding whether you would like to spawn your preferred text editor with the results after a successfull Jira query. To make use of this, please set the EDITOR enviroment variable before invoking Jipdate, e.g., something like:

export EDITOR=vim

server

Jipdate will use a default (Linaro) Jira server, but the user can set the Jira server in the configuration file. Authentication is required when querying a Jira server, and jipdate supports password based authentication, as well as token based. Using token authentication is considered more secure than password. The server configuration must include at least an url attribute. A token attribute can be added optionally. To create an API token, follow the procedure described in the Atlassian documentation.

When the token attribute is present, Jipdate will use token based authentication. Otherwise, it will use password based authentication.

Here is an example to show how to add a server entry in the configuration file, assuming token based authentication:

# Jira server information
server:
  url: https://linaro.atlassian.net
  token: abcdefghijkl

username

If this exists in the config, then jipdate will not ask for the username when running the script (see the Example config for the syntax).

password

This is similar to the username above, i.e., if your Jira password is stored here, then jipdate won’t ask for it when running the script.

Warning

Storing your password here in clear text requires some extra precaution, since anyone with access to your computer can rather easy read the contents of this file. I.e., it’s not really recommended to use this feature, you’re better off just typing the password when running the script or export JIRA_PASSWORD as an enviroment variable, when you need to run script multiple times in row and don’t want to type it in each and every time.