Skip to content

plouc/mozaik-ext-jira

Repository files navigation

Mozaïk jira widgets

NPM version Travis CI License

Client Configuration

In order to use the Mozaïk jira widgets, you must configure its client. Configuration is loaded from environment variables.

env key required default description
JIRA_PROTOCOL no 'http' http or https
JIRA_HOST yes jira host (without protocol)
JIRA_USERNAME yes username for auth
JIRA_PASSWORD yes password for auth

You also have the ability to use multiple clients, you'll have to set the client parameter on your widget:

dashboards:
-
  title: '@mozaik/ext-jira demo'
  #
  widgets:
  -
    # will use 'default' client, JIRA_* environment variables
    extension: jira
    widget:    Project
    #
  -
    # will use 'other' client, JIRA_OTHER_* environment variables
    extension: jira
    widget:    Project
    client:    other <— HERE IT IS
    #

when you define the client property, the loaded environment variables must have the form JIRA_<uppercased_client_id>_<key>, for example:

  • JIRA_OTHER_PROTOCOL
  • JIRA_OTHER_HOST

Project

Display information about jira project.

parameters

key required description
projectId yes ID of the project

ProjectVersions

List jira project's versions.

parameters

key required description
projectId yes ID of the project

ProjectVersionUnresolvedIssueCount

Display count of unresolved issues for a given project version.

parameters

key required description
projectId yes ID of the project
versionName yes name of the project's version