stig / Ox Jira.el

#+TITLE: JIRA Backend for Org Export Engine #+AUTHOR: Stig Brautaset

[[http://melpa.org/#/ox-jira][file:http://melpa.org/packages/ox-jira-badge.svg]] [[https://travis-ci.org/stig/ox-jira.el][file:https://travis-ci.org/stig/ox-jira.el.svg?branch=master]]

• Introduction

  This module plugs into the regular Org Export Engine and transforms Org files to JIRA markup for pasting into JIRA tickets & comments.

  My last three jobs I've had to use JIRA, and had to deal with its (to me) incredibly unintuitive markup format. Having discovered---and fallen in love with---Org mode I now find myself writing everything in Org and exporting to various other formats (html, markdown, plain text) but I haven't been able to find a way to export to JIRA. So I am attempting to write one, and learn about Emacs package development at the same time.

• Usage

  In an Org buffer, hit =C-c C-e j j= to bring up =Org Export Dispatcher= and export it as a JIRA buffer. You can then use =C-x h= to mark the whole buffer, then =M-w= to save it to the kill ring (and global pasteboard) for pasting into JIRA issues.

  Alternatively, you can export to the kill ring automatically for interactive exports by setting this in your =.emacs.el= file:

  #+BEGIN_SRC emacs-lisp (setq org-export-copy-to-kill-ring 'if-interactive) #+END_SRC

• Installation

  This library is on Melpa. You can install it like this:

  #+BEGIN_EXAMPLE M-x package-install RET ox-jira RET #+END_EXAMPLE

• Manual installation

  If you don't want to install from Melpa, simply clone this repo and do:

  #+BEGIN_EXAMPLE M-x load-file RET ox-jira.el RET #+END_EXAMPLE

• Maturity

  It does what I want, and it has tests for that. YMMV.

• License

  Copyright (C) 2016 Stig Brautaset

  This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

  You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

• Contributing

  I'm happy to consider contributions. Since this is my first attempt at an Emacs package I've bound to have made lots of mistakes. Help me correct them, and keep the pull requests coming!

  I am more likely to merge code contributions if they come with tests. However, code contributions are not everything. Opening an issue with a reproducible test case, like "I expected this but got this" is also a valuable contribution.

  Running the =./run-tests.sh= script should run all the tests automatically.