Browse files

Enhance the README, minor cleanup.

  • Loading branch information...
1 parent 635105a commit 3aa2ad586be193e22245b6bba4a2d889e9016b4c @kylecordes kylecordes committed Jul 15, 2012
Showing with 28 additions and 7 deletions.
  1. +26 −6 README
  2. +1 −0 project.clj
  3. +1 −1 src/ghijira/core.clj
View
32 README
@@ -10,17 +10,37 @@ Note that comment import is broken in JIRA import 4.1.4, and works
correctly starting with JIRA import 4.2. As of June 2012, unfortunately
the version deployed in JIRA OnDemand is 4.1.4.
+For background information, see the announcement blog post:
+
+http://kylecordes.com/2012/github-issues-export-jira
+
## Usage
-Use lein deps to download the dependencies.
+I expect some users of this tool to start without Clojure knowledge (i.e. just want to export JIRA data, not learn Clojure), so here are hopefully sufficient instructions for that.
+
+Install Java.
+
+You don't need to install Clojure - Leiningen will do that for you.
+
+Install Leiningen:
+
+https://github.com/technomancy/leiningen/
+
+Either the new 2.x version, or old 1.x version, should work. (Typically you just download the lein script, and put it in your ~/bin directory.)
+
+Download ghijira (this software), either with "git clone" or by downloading a ZIP from Github.
+
+Navigate to its directory in your command prompt.
+
+Use "lein deps" to download the dependencies. Leiningen will download all of the various JAR files needed, including Clojure itself.
+
+Edit config.clj with your project settings. This is a Clojure file, but you should be able to follow the syntax enough to fill in your project specifics.
-Edit config.clj with your project settings.
+Run the ghijira code, using Leiningen: "lein run". This will take a while, depending on the number of issues in your project, because the Github Issues API requires a separate requires for each Issue to download its comments.
-Run the Clojure code, either in an IDE or via lein.
+Import the resulting JIRA.csv file into JIRA. To get this right, you need to use a JIRA import configuration file. This ghijira project includes an example. Of particular importance is the comment setting, required for comment import to work. To clarify, this JIRA import configuration file is *not* part of the Clojure code, rather it is something JIRA needs.
-Import the resulting JIRA.CSV file in to JIRA. A sample
-JIRA import configuration file is provided, the comment
-setting is required for comment import to work.
+Information about such a file is linked in the blog post mentioned earlier.
## License
View
1 project.clj
@@ -8,4 +8,5 @@
:dev-dependencies [
[lein-eclipse "1.0.0"]
]
+ :main ghijira.core
)
View
2 src/ghijira/core.clj
@@ -8,7 +8,7 @@
(ns ghijira.core
"Export GitHub Issues to JIRA-compatible CSV format"
- (:require [clojure.pprint :as pp]
+ (:require [clojure.pprint :as pprint]
[clojure.string :only replace]
[clojure.data.csv :as csv]
[clojure.java.io :as io]

0 comments on commit 3aa2ad5

Please sign in to comment.