jiraprinter

2.4.0 • Public • Published

Build Status Code Coverage Code Climate Codecov status bitHound Overall Score bitHound Dependencies Dependency Status Current Version JS Standard Style CII Best Practices

jiraprinter

As a JIRA user, I want to be able to print out my current sprint's stories, so that I can post them on a physical Kanban board.

Sample output

Background

While JIRA has a UI for tracking and interacting with the current sprint's stories, teams easily become distracted while using it together — the group ends up huddled around a laptop arguing about the best way to filter the search query, or getting lost in unimportant details. Sometimes low-tech solutions can be the most powerful: physical cards representing the stories.

This is a very simple app that queries JIRA to list all of the stories in the team's current sprint, and provide an HTML page with print-optimized CSS rules.

Each story is printed out as a half-page (US Letter) card, with the Story number, the summary, and the priority. As a bonus, a QR code is provided which will take you directly to the story from your smartphone.

Usage

with Docker

You can run jiraprinter in Docker:

$ docker run -d -p 8080:80 -e JIRA_PASS -e JIRA_USER=me -e JIRA_HOST=myjira.example.com hairyhenderson/jiraprinter

Or, you can use npm to install it:

install

$ npm install -g jiraprinter

run it!

$ jiraprinter --help
 
  Usage: jiraprinter [options]
 
  Options:
 
    -h, --help                                  output usage information
    -V, --version                               output the version number
    -u, --user [username]                       The JIRA username ($JIRA_USER)
    --password [password]                       The JIRA password ($JIRA_PASS)
    -h, --host [host]                           The JIRA hostname ($JIRA_HOST)
    --printQR [printQR]                         Whether to include an issue link QR code in the print out ($PRINT_QR) - defaults to true
    -f, --fieldOverrides [fieldOverrides]       Comma (,) seperated list of fields to replace with custom field names (e.g. "-f estimation:fields.customfield_1,name:fields.custom_field2")
    --boardName [boardName]                     Filter boards by name
$ jiraprinter -h myjira.example.com -u me

You should probably only ever use $JIRA_PASS, and not the --password flag!

Now, connect with your browser at http://localhost:3000, select your board, and when the UI's fully populated with your stories, print the page!

License

The MIT License

Copyright (c) 2015 Dave Henderson

Readme

Keywords

Package Sidebar

Install

npm i jiraprinter

Weekly Downloads

1

Version

2.4.0

License

MIT

Last publish

Collaborators

  • dhenderson