Giter Club home page Giter Club logo

jiradoc's Introduction

JIRAdoc

Simplify the insertion of sub-tasks into JIRA by defining them in a specially formatted text file and sending them to the JIRA REST API. Hopefully, this saves you the trouble of going through the same UI dialogs over and over again to create a new sub-task.

Prerequisites

You should have an installed version of Python on your system.

Installation

Use Python's package manager to install the application, it comes bundled with Python on both Windows and Linux.

$ pip install git+https://github.com/lucianovdveekens/jiradoc

Usage

The example below showcases the format of the expected input:

= ABC-1 My story
CODE:
- This is a coding task to implement a feature @ 8h
-- With an optional description
TEST:
- Write test specification @ 4h
- Test the new feature @ 4h
FD:
- Update the functional design @ 1h
MANUAL:
- Add a section describing the new functionality @ 2h

Only one story is shown here, but it's okay to define multiple stories in a single file. Once you're ready to insert them, run the following command:

$ python -m jiradoc tasks.txt
Logging to: /home/luciano/.cache/jiradoc/log/jiradoc.log
Creating configuration file at: /home/luciano/.config/jiradoc/config.yml
Loading configuration: /home/luciano/.config/jiradoc/config.yml
Created sub-task 'ABC-2 This is a coding task to implement a feature'
Created sub-task 'ABC-3 Write test specification'
Created sub-task 'ABC-4 Test the new feature'
Created sub-task 'ABC-5 Update the functional design'
Created sub-task 'ABC-6 Add a section describing the new functionality'

Now you can open JIRA to see the result:

Alt text

Configuration

TODO

Running the tests

TODO

License

This project is licensed under the MIT License - see the LICENSE file for details.

jiradoc's People

Contributors

lvanderveekens avatar

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.