drayah/girajira

Girajira

Girajira is a small clojure web api that automates Jira card transitions via opened github pull requests.

Prerequisites

• JDK 8 or above
• Leiningen 2.8.1 or above.

Testing & Plugins

Girajira uses Midje for automated tests.

Recommended user plugins are:

• CIDER nREPL
• Ultra

A sample ~/.lein/profiles.clj:

{:user {:plugins [[cider/cider-nrepl "0.16.0"]
                  [venantius/ultra "0.5.2"]]
        :dependencies [[org.clojure/tools.nrepl "0.2.13"]]}}

Running tests using Midje

Enter the project directory and run the tests by using the lein midje command in your terminal.

Running tests automatically

Midje allows you to automatically run your tests whenever you change your source code. To automatically run your tests use the lein midje :autotest command.

Running code coverage

We're using cloverage for code coverage. Generate the coverage report by running lein cloverage --runner :midje in your terminal.

Configuring Aero

Girajira uses Aero for enviroment configuration. In order to be able to perform requests to Jira's API you need to setup a .secrets.edn configuration file in the project's config directory. This file will be ignored by git.

A sample config/.secrets.edn:

{:jira
  {:url "https://YOUR_JIRA_URL"
   :username "JIRA_USERNAME"
   :password "JIRA_PASSWORD"}}

Running

To start a web server for the application, run:

lein ring server

License

MIT

girajira's Issues

Create a docker configuration in order to build on travis

Link code coverage with travis ci

Get all issues for an existing project

Change configuration in order to run server on port 80

When building an uberjar using lein ring uberjar it would be nice to run the server on port 80

Change configuration in order to be able to run on heroku

Create docker with clojure and java dependencies for hosting + environment variables (jira config)

Refactor github pull-request event in order to decouple from jira transition

We'd like to post to slack whenever a PR gets opened. The current github pull request event is tightly coupled to the jira transition subscriber. We should generalize so other subscribers, e.g. a slack subscriber, can also perform some action

Create api to return all existing jira projects