Skip to content

Automatically convert graphviz diagrams into images when uploading to JIRA.

Notifications You must be signed in to change notification settings

coddingtonbear/jirafs-graphviz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jirafs graphviz Macro

This Jirafs plugin adds a macro allowing you to easily embed graphs generated with Graphviz's easy-to-use markup.

http://coddingtonbear-public.s3.amazonaws.com/github/jirafs-graphviz/demo_v1.gif

and the comment posted will appear in Jira as:

http://coddingtonbear-public.s3.amazonaws.com/github/jirafs-graphviz/demo_v1_jira.png

Quickstart

You can enter a digraph into your document by using the graphviz macro:

<jirafs:graphviz>
   digraph {
      a -> b;
   }
</jirafs:graphviz>

or:

<jirafs:graphviz src="name-of-digraph-file.dot" />

Options

You can control the type and characteristics of the graph generated by specifying any of the following attributes:

  • src: Use the referenced file for your graph's contents. Note that this cannot be specified if graph contents are specified directly in your tag's contents.
  • command: (Default: dot) Which graphviz command to execute. Common options include 'dot' and 'neato', but may vary depending upon your graphviz installation.
  • format: (Default: png) File format to generate.

Installation

  1. Install from PIP:

    pip install jirafs-graphviz
    
  2. Enable for a ticket folder:

    jirafs plugins --enable=graphviz
    

Note that you can globally enable this (or any) plugin by adding the --global flag to the above command:

jirafs plugins --global --enable=graphviz

Requirements

  • Graphviz

About

Automatically convert graphviz diagrams into images when uploading to JIRA.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Languages