Git Product home page Git Product logo

compulsor's Introduction

compulsor

This client application will help gather pulse reporting information from jira and post it to discourse. It is very purpose-built and likely only useful if you are working at Canonical.

configuration

You need a ~/.canonicalrc like so, it should be mode 600.

services:
  jira:
    url: "https://warthogs.atlassian.net"
    username: "your_email"
    token: "your_jira_token"     # Get this from
  discourse:                     #   https://id.atlassian.com/manage-profile/security/api-tokens
    ubuntu:
      url: "https://discourse.ubuntu.com"
      username: "your_username"
      key: "your_token"          # You'll need an admin to get you one 
    canonical:
      url: "https://discourse.canonical.com"
      username: "your_username"
      key: "your_token"

tools:
  compulsor:
    project: "your_project_key"    # Your project key, e.g. CT
    board: your-sprint-board-id    # The id of your sprint board, see the URL when you are on it
    reportfield: customfield_10576 # The field to get sprint reports from.
    discourse:
      ubuntu:
        topic: 123                 # the topic id to post to
        keys: false                # If true, jira keys will be included
      canonical:
        topic: 234
        keys: true
        private: true              # If private items should be shared

Installation and Use

Here is how to install and run:

$ pip install git+https://github.com/kewisch/compulsor.git
$ compulsor --help
Usage: compulsor [OPTIONS] COMMAND [ARGS]...

Options:
  --debug  Enable debugging

Commands:
  postpulse  Post pulse reports to discourse
  showpulse  Display a formatted pulse report

$ compulsor showpulse --help
Usage: compulsor showpulse [OPTIONS] [PULSE]...

  Display a formatted pulse report

Options:
  -k, --keys  Show Jira keys in the report

$ compulsor postpulse --help
Usage: compulsor postpulse [OPTIONS] [PULSE] [DISCOURSES]...

  Post pulse reports to discourse

Options:
  -a, --all  Post pulse report to all configured discourses

Gathering Information

On your jira project, add a custom field "Pulse Report Description" where folks on the team should be adding what they've done for the ticket. Make sure that not everything starts with "We did x", otherwise it will sound very mechanical.

If the information is currently confidential, add [CONFIDENTIAL] to the pulse report description.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.