/sprint-update

Generate markdown formatted sprint updates based on the Jira tickets were involved in the given sprint.

Primary LanguageGoMIT LicenseMIT

Sprint update

Generate markdown formatted sprint updates based on the Jira tickets were involved in the given sprint.

Github license

Installation

Installing with brew

$ brew tap gabor-boros/brew
$ brew install sprint-update

Manual installation

To install sprint-update, use one of the release artifacts or simply run go install https://github.com/gabor-boros/sprint-update.

Configuration file

Create a new configuration file $HOME/.sprint-update.toml with the following content:

jira-url = "<Jira server URL>"
jira-username = "<Jira username>"
jira-password = "<Jira password>"

Usage

Generate a sprint update in Discourse-compatible Markdown format.

Usage:
  sprint-update [flags]

Examples:
sprint-update --sprint se.253 -e

Flags:
      --config string          config file (default is $HOME/.sprint-update.yaml)
  -e, --end-of-sprint          indicate end of sprint update
  -h, --help                   help for sprint-update
      --jira-password string   jira user password
      --jira-url string        jira server URL
      --jira-username string   jira user username
  -s, --sprint string          sprint name (ex: SE.253)
      --version                show command version

Development

To install everything you need for development, run the following:

$ git clone git@github.com:gabor-boros/sprint-update.git
$ cd sprint-update
$ make prerequisites
$ make deps

Contributors